Clipboard

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides methods to place data on and retrieve data from the system Clipboard. This class cannot be inherited.

C#

public class Clipboard

VB.NET

Public Class Clipboard

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

Indicates whether there is data on the Clipboard in the WaveAudio format.

Returns: Boolean. true if there is audio data on the Clipboard; otherwise, false.

ContainsData(format)

Indicates whether there is data on the Clipboard that is in the specified format or can be converted to that format.

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

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

ContainsFileDropList()

Indicates whether there is data on the Clipboard that is in the FileDrop format or can be converted to that format.

Returns: Boolean. true if there is a file drop list on the Clipboard; otherwise, false.

ContainsImage()

Indicates whether there is data on the Clipboard that is in the Bitmap format or can be converted to that format.

Returns: Boolean. true if there is image data on the Clipboard; otherwise, false.

ContainsText()

Indicates whether there is data on the Clipboard in the Text or UnicodeText format, depending on the operating system.

Returns: Boolean. true if there is text data on the Clipboard; otherwise, false.

ContainsText(format)

Indicates whether there is text data on the Clipboard in the format indicated by the specified TextDataFormat value.

Parameter	Type	Description
format	TextDataFormat	One of the TextDataFormat values.

Returns: Boolean. true if there is text data on the Clipboard in the value specified for format ; otherwise, false.

GetAudioStream()

Retrieves an audio stream from the Clipboard.

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

GetData(format)

Retrieves data from the Clipboard in the specified format.

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

Returns: Object. An Object representing the Clipboard data or null if the Clipboard does not contain any data that is in the specified format or can be converted to that format.

GetDataObject()

Retrieves the data that is currently on the system Clipboard.

Returns: IDataObject. An IDataObject that represents the data currently on the Clipboard, or null if there is no data on the Clipboard.

GetFileDropList()

Retrieves a collection of file names from the Clipboard.

Returns: StringCollection. A StringCollection containing file names or null if the Clipboard does not contain any data that is in the FileDrop format or can be converted to that format.

GetImage()

Retrieves an image from the Clipboard.

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

GetText()

Retrieves text data from the Clipboard in the Text or UnicodeText format, depending on the operating system.

Returns: String. The Clipboard text data or Empty if the Clipboard does not contain data in the Text or UnicodeText format, depending on the operating system.

GetText(format)

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

Parameter	Type	Description
format	TextDataFormat	One of the TextDataFormat values.

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

SetAudio(audioBytes)

Saves the Byte array in the WaveAudio format after converting it to a Stream to the clipboard.

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

Throws:

• ArgumentNullException audioBytes is null.

SetAudio(audioStream)

Saves the Stream in the WaveAudio format to the clipboard.

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

Throws:

• ArgumentNullException audioStream is null.

SetClientText(text)

Saves the text data to the client's temporary clipboard. Client side javascript code can copy the clipboard's content to the browser's clipboard calling Wisej.Core.copy();

Parameter	Type	Description
text	String	The text to save to the client's temporary clipboard.

Throws:

• ArgumentNullException text is null.

SetData(format, data)

Saves the specified data to the clipboard in the specified format.

Parameter	Type	Description
format	String	The format of the data to set. See DataFormats for predefined formats.
data	Object	An Object representing the data to add.

Throws:

• ArgumentNullException data is null.

SetDataObject(data)

Saves the specified data to the clipboard.

Parameter	Type	Description
data	Object	The data to place on the Clipboard.

Throws:

• ArgumentNullException The value of data is null.

SetFileDropList(filePaths)

Saves the collection of file names in the FileDrop format to the clipboard.

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

Throws:

• ArgumentNullException filePaths is null.
• ArgumentException filePaths does not contain any strings, or at least one of the strings in filePaths is empty, contains only white space, contains one or more invalid characters as defined by InvalidPathChars, is null, contains a colon (:), or exceeds the system-defined maximum length. See the InnerException property of the ArgumentException for more information.

SetImage(image)

Saves the Image in the Bitmap format to the clipboard

Parameter	Type	Description
image	Image	The Image to add to the Clipboard.

Throws:

• ArgumentNullException image is null.

SetText(text)

Saves the text data in the UnicodeText format to the clipboard.

Parameter	Type	Description
text	String	The text to add to the Clipboard.

Throws:

• ArgumentNullException text is null or Empty.

SetText(text, format)

Saves the text data in the format indicated by the specified TextDataFormat value to the clipboard.

Parameter	Type	Description
text	String	The text to add to the Clipboard.
format	TextDataFormat	One of the TextDataFormat values.

Throws:

• ArgumentNullException text is null.