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.

public class Clipboard

Public Class Clipboard

Methods

Clear()

Removes all data from the Clipboard.

ContainsAudio()

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

Returns: . 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.

Returns: . 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 format or can be converted to that format.

Returns: . 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 format or can be converted to that format.

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

ContainsText()

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

Returns: . 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 value.

Returns: . 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: . A containing audio data or null if the Clipboard does not contain any data in the format.

GetData(format)

Retrieves data from the Clipboard in the specified format.

Returns: . An 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: . An 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: . A containing file names or null if the Clipboard does not contain any data that is in the format or can be converted to that format.

GetImage()

Retrieves an image from the Clipboard.

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

GetText()

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

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

GetText(format)

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

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

SetAudio(audioBytes)

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

Throws:

• audioBytes is null.

SetAudio(audioStream)

Saves the in the format to the clipboard.

Throws:

• 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();

Throws:

• text is null.

SetData(format, data)

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

Throws:

• data is null.

SetDataObject(data)

Saves the specified data to the clipboard.

Throws:

• The value of data is null.

SetFileDropList(filePaths)

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

Throws:

• filePaths is null.

• 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 , is null, contains a colon (:), or exceeds the system-defined maximum length. See the property of the for more information.

SetImage(image)

Saves the in the format to the clipboard

Throws:

• image is null.

SetText(text)

Saves the text data in the format to the clipboard.

Throws:

• text is null or .

SetText(text, format)

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

Throws:

• text is null.