DataObject

Wisej.Web.DataObject

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.1.0.0)

Implements a basic data transfer mechanism.

C#

public class DataObject : IDataObject

VB.NET

Public Class DataObject
    Inherits IDataObject

Constructors

DataObject()

Initializes a new instance of the DataObject class.

DataObject(data)

Initializes a new instance of the DataObject class and adds the specified object to it.

Name	Type	Description
data	Object	The data to store.

DataObject(format, data)

Initializes a new instance of the DataObject class and adds the specified object in the specified format.

Name	Type	Description
format	String	The format of the specified data. See DataFormats for predefined formats.
data	Object	The data to store.

DataObject(format, data)

Initializes a new instance of the DataObject class and adds the specified object in the specified format.

Name	Type	Description
format	Type	A Type representing the format of the data.
data	Object	The data to store.

Methods

ContainsAudio()

Indicates whether the data object contains data in the WaveAudio format.

Returns: Boolean. true if the data object contains audio data; otherwise, false.

ContainsFileDropList()

Indicates whether the data object contains data that is in the FileDrop format or can be converted to that format.

Returns: Boolean. true if the data object contains a file drop list; otherwise, false.

ContainsImage()

Indicates whether the data object contains data that is in the Bitmap format or can be converted to that format.

Returns: Boolean. true if the data object contains image data; otherwise, false.

ContainsText()

Indicates whether the data object contains data in the UnicodeText format.

Returns: Boolean. true if the data object contains text data; otherwise, false.

ContainsText(format)

Indicates whether the data object contains text data in the format indicated by the specified TextDataFormat value.

Parameter	Type	Description
format	TextDataFormat	One of the TextDataFormat values.

Returns: Boolean. true if the data object contains text data in the specified format; otherwise, false.

GetAudioStream()

Retrieves an audio stream from the data object.

Returns: Stream. A Stream containing audio data or null if the data object does not contain any data in the WaveAudio format.

GetData(format)

Returns the data associated with the specified class type format.

Parameter	Type	Description
format	Type	A Type representing the format of the data to retrieve.

Returns: Object. The data associated with the specified format, or null.

GetData(format)

Returns the data associated with the specified data format.

Parameter	Type	Description
format	String	The format of the data to retrieve. See DataFormats for predefined formats.

Returns: Object. The data associated with the specified format, or null.

GetData(format, autoConvert)

Returns the data associated with the specified data format, using an automated conversion parameter to determine whether to convert the data to the format.

Parameter	Type	Description
format	String	The format of the data to retrieve. See DataFormats for predefined formats.
autoConvert	Boolean	true to the convert data to the specified format; otherwise, false.

Returns: Object. The data associated with the specified format, or null.

GetDataPresent(format)

Determines whether data stored in this DataObject is associated with, or can be converted to, the specified format.

Parameter	Type	Description
format	Type	A Type representing the format to check for.

Returns: Boolean. true if data stored in this DataObject is associated with, or can be converted to, the specified format; otherwise, false.

GetDataPresent(format)

Returns the data associated with the specified class type format.

Parameter	Type	Description
format	String	A Type representing the format of the data to retrieve.

Returns: Boolean. The data associated with the specified format, or null.

GetDataPresent(format, autoConvert)

Determines whether this DataObject contains data in the specified format or, optionally, contains data that can be converted to the specified format.

Parameter	Type	Description
format	String	The format to check for. See DataFormats for predefined formats.
autoConvert	Boolean	true to determine whether data stored in this DataObject can be converted to the specified format; false to check whether the data is in the specified format.

Returns: Boolean. true if the data is in, or can be converted to, the specified format; otherwise, false.

GetFileDropList()

Returns the list of file types from the data object.

Returns: String[]. A string array containing the file types in the data object.

GetFiles()

Returns the HttpFileCollection of files uploaded by the client in a drag & drop operation.

Returns: HttpFileCollection. A string array containing the file types in the data object.

GetFormats()

Returns a list of all formats that data stored in this DataObject is associated with or can be converted to.

Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.

GetFormats(autoConvert)

Returns a list of all formats that data stored in this DataObject is associated with or can be converted to, using an automatic conversion parameter to determine whether to retrieve only native data formats or all formats that the data can be converted to.

Parameter	Type	Description
autoConvert	Boolean	true to retrieve all formats that data stored in this DataObject is associated with, or can be converted to; false to retrieve only native data formats.

Returns: String[]. An array of type String, containing a list of all formats that are supported by the data stored in this object.

GetImage()

Retrieves an image from the data object.

Returns: Image. An Image representing the image data in the data object or null if the data object does not contain any data that is in the Bitmap format or can be converted to that format.

GetText()

Retrieves text data from the data object in the UnicodeText format.

Returns: String. The text data in the data object or Empty if the data object does not contain data in the UnicodeText format.

GetText(format)

Retrieves text data from the data object in the format indicated by the specified TextDataFormat value.

Parameter	Type	Description
format	TextDataFormat	One of the TextDataFormat values.

Returns: String. The text data in the data object or Empty if the data object does not contain data in the specified format.

SetAudio(audioBytes)

Adds a Byte array to the data object in the WaveAudio format after converting it to a Stream.

Parameter	Type	Description
audioBytes	Byte[]	A Byte array containing the audio data.

Throws:

• ArgumentNullException audioBytes is null.

SetAudio(audioStream)

Adds a Stream to the data object in the WaveAudio format.

Parameter	Type	Description
audioStream	Stream	A Stream containing the audio data.

Throws:

• ArgumentNullException audioStream is null.

SetData(data)

Adds the specified object to the DataObject using the object type as the data format.

Parameter	Type	Description
data	Object	The data to store.

SetData(format, data)

Adds the specified object to the DataObject using the specified type as the format.

Parameter	Type	Description
format	Type	A Type representing the format associated with the data.
data	Object	The data to store.

SetData(format, data)

Adds the specified object to the DataObject using the specified format.

Parameter	Type	Description
format	String	The format associated with the data. See DataFormats for predefined formats.
data	Object	The data to store.

SetData(format, autoConvert, data)

Adds the specified object to the DataObject using the specified format and indicating whether the data can be converted to another format.

Parameter	Type	Description
format	String	The format associated with the data. See DataFormats for predefined formats.
autoConvert	Boolean	true to allow the data to be converted to another format; otherwise, false.
data	Object	The data to store.

SetDownloadURL(url, fileName)

Adds a url using DownloadURL format. The specified url is parsed to compose the DownloadURL as: "mime-type:file-name:url".

Parameter	Type	Description
url	String	The url to the file to download.
fileName	String	The name of the file to download from the url.

SetFileDropList(filePaths)

Adds a collection of file names to the data object in the FileDrop format.

Parameter	Type	Description
filePaths	StringCollection	A StringCollection containing the file names.

Throws:

• ArgumentNullException filePaths is null.

SetFileDropList(filePaths)

Adds a collection of file names to the data object in the FileDrop format.

Parameter	Type	Description
filePaths	String[]	A StringCollection containing the file names.

Throws:

• ArgumentNullException filePaths is null.

SetImage(image)

Adds an Image to the data object in the Bitmap format.

Parameter	Type	Description
image	Image	The Image to add to the data object.

Throws:

• ArgumentNullException image is null.

SetText(textData)

Adds text data to the data object in the UnicodeText format.

Parameter	Type	Description
textData	String	The text to add to the data object.

Throws:

• ArgumentNullException textData is null or Empty.

SetText(textData, format)

Adds text data to the data object in the format indicated by the specified TextDataFormat value.

Parameter	Type	Description
textData	String	The text to add to the data object.
format	TextDataFormat	One of the TextDataFormat values.

Throws:

• ArgumentNullException textData is null or Empty.

Implements

Name	Description
IDataObject	Provides a format-independent mechanism for transferring data.