DataObject.GetText Method (TextDataFormat)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual string GetText(
	TextDataFormat format


Type: System.Windows.Forms.TextDataFormat

One of the TextDataFormat values.

Return Value

Type: System.String

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

Exception Condition

format is not a valid TextDataFormat value.

Use the ContainsText method to determine whether the data object contains text data before retrieving it with this method.

Use the SetText method to add text data to the data object.

.NET Framework
Available since 2.0
Return to top