New to Telerik UI for WPF? Start a free 30-day trial

ClipboardEx

Class

A class providing additional methods for working with the clipboard.

Definition

Namespace:Telerik.Windows.Documents.Base

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public static class ClipboardEx

Inheritance: objectClipboardEx

Properties

ClipboardHandlers

List<ClipboardHandler>

Collection of ClipboardHandlers that will be used when getting rich-text content from the clipboard.

public static List<ClipboardHandler> ClipboardHandlers { get; }

Property Value:

The clipboard handlers.

Methods

ContainsDocument()

Determines whether the clipboard contains supported rich-text data.

public static bool ContainsDocument()

Returns:

bool

true if the clipboard contains document; otherwise, false.

ContainsText(KeyEventArgs)

Determines whether the clipboard contains plain text.

public static bool ContainsText(KeyEventArgs pasteKeyEventArgs)

Parameters:pasteKeyEventArgsKeyEventArgs

The KeyEventArgs instance containing the event data. Use null if such is not present./>

Returns:

bool

true if the clipboard contains text; otherwise, false.

GetDocument()

Obtains a DocumentFragment from the clipboard using the registered ClipboardHandlers.

public static DocumentFragment GetDocument()

Returns:

DocumentFragment

a DocumentFragment instance representing the document created from the content inside the clipboard. If the operation is not successful, the method returns null.

GetDocument(out PasteSource?)

Obtains a DocumentFragment from the clipboard using the registered ClipboardHandlers.

public static DocumentFragment GetDocument(out PasteSource? pasteSource)

Parameters:pasteSourcePasteSource?

The PasteSource that is resolved during clipboard processing.

Returns:

DocumentFragment

a DocumentFragment instance representing the document created from the content inside the clipboard. If the operation is not successful, the method returns null.

GetDocumentFromClipboard(string, Func<string, string>)

Gets a DocumentFragment from clipboard using the specified data format.

public static DocumentFragment GetDocumentFromClipboard(string dataFormat, Func<string, string> clipboardStringFilter = null)

dataFormat

string

The data format. You can use the set of formats provided in the class.

clipboardStringFilter

Func<string, string>

A function to filter the string inside the clipboard. This function is used when the content needs to be formatted additionally before creating a document from it.

        <p>HTML content inserted by MS Word can be stripped using <xref href="Telerik.Windows.Documents.Base.ClipboardEx.StripHtmlClipboardFormatHeaders(System.String)" data-throw-if-not-resolved="false"></xref>.</p>

Returns:

DocumentFragment

A DocumentFragment instance representing the content. If the operation did not succeed, the method return null.

GetDocumentFromClipboard(string, out PasteSource?, Func<string, string>)

Gets a DocumentFragment from clipboard using the specified data format.

public static DocumentFragment GetDocumentFromClipboard(string dataFormat, out PasteSource? pasteSource, Func<string, string> clipboardStringFilter = null)

dataFormat

string

The data format. You can use the set of formats provided in the class.

pasteSource

PasteSource?

The PasteSource that is resolved during clipboard processing.

clipboardStringFilter

Func<string, string>

A function to filter the string inside the clipboard. This function is used when the content needs to be formatted additionally before creating a document from it.

        <p>HTML content inserted by MS Word can be stripped using <xref href="Telerik.Windows.Documents.Base.ClipboardEx.StripHtmlClipboardFormatHeaders(System.String)" data-throw-if-not-resolved="false"></xref>.</p>

Returns:

DocumentFragment

A DocumentFragment instance representing the content. If the operation did not succeed, the method return null.

GetText()

Gets the clipboard data of type .

public static string GetText()

Returns:

string

The string representing the content or Empty if there is no text in the clipboard.

SetDataObject(IDataObject)

Places a specified data object in the system Clipboard.

public static void SetDataObject(IDataObject dataObject)

Parameters:dataObjectIDataObject

A data object (an object that implements IDataObject) to place on the system Clipboard.

SetDocument(DocumentFragment, IDataObject)

Sets a document represented by a DocumentFragment instance to the specified data object.

public static void SetDocument(DocumentFragment documentFragment, IDataObject dataObject)

Parameters:documentFragmentDocumentFragment

The document fragment.

dataObjectIDataObject

The object the document fragment should be inserted into.

SetDocument(DocumentFragment)

Sets a document represented by a DocumentFragment instance to the system clipboard.

public static void SetDocument(DocumentFragment documentFragment)

Parameters:documentFragmentDocumentFragment

The document fragment.

SetText(string, DataObject)

Stores data, specified as a string, in the specified data object.

public static void SetText(string textData, DataObject dataObject)

Parameters:textDatastring

The string representing the text data.

dataObjectDataObject

The data object.

SetText(string)

Stores data, specified as a string, in the system clipboard.

public static void SetText(string textData)

Parameters:textDatastring

The text data.

StripHtmlClipboardFormatHeaders(string)

Strips the clipboard format headers from the HTML content inserted in the clipboard by MS Word. Skips all lines in the beginning containing ':'.

public static string StripHtmlClipboardFormatHeaders(string clipboardText)

Parameters:clipboardTextstring

The clipboard text.

Returns:

string

The stripped HTML string.