DataObject::SetText Method (String^, TextDataFormat)

.NET Framework (current version)

Adds text data to 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)

Syntax

public:
virtual void SetText(
	String^ textData,
	TextDataFormat format
)

Parameters

textData: Type: System::String^
The text to add to the data object.

format: Type: System.Windows.Forms::TextDataFormat
One of the TextDataFormat values.

Exceptions

Exception	Condition
ArgumentNullException	textData is null or Empty.
InvalidEnumArgumentException	format is not a valid TextDataFormat value.

Remarks

To retrieve text data from the data object, first use the ContainsText method to determine whether the data object contains image data before retrieving it with the GetText method.

Version Information

.NET Framework
Available since 2.0