DataFormats.Text Field

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the standard ANSI text format. This static field is read-only.

public: static initonly System::String ^ Text;

public static readonly string Text;

 staticval mutable Text : string

Public Shared ReadOnly Text As String

Field Value

String

Examples

The following code example demonstrates the use of this member.

try
{
   String^ myString = "This is a String from the ClipBoard";
   
   // Sets the data into the Clipboard.
   Clipboard::SetDataObject( myString );
   IDataObject^ myDataObject = Clipboard::GetDataObject();
   // Checks whether the format of the data is 'UnicodeText' or not.
   if ( myDataObject->GetDataPresent( DataFormats::UnicodeText ) )
   {
      Console::WriteLine( "Data in 'UnicodeText' format: " +
         myDataObject->GetData( DataFormats::UnicodeText ) );
   }
   else
   {
      Console::WriteLine( "No String information was contained in the clipboard." );
   }

   // Checks whether the format of the data is 'Text' or not.
   if ( myDataObject->GetDataPresent( DataFormats::Text ) )
   {
      String^ clipString = (String^)(myDataObject->GetData( DataFormats::StringFormat ));
      Console::WriteLine( "Data in 'Text' format: {0}", clipString );
   }
}
catch ( Exception^ e ) 
{
   Console::WriteLine( e->Message );
}

  try
  {

      String myString = "This is a String from the ClipBoard";

      // Sets the data into the Clipboard.
      Clipboard.SetDataObject(myString);
      IDataObject myDataObject = Clipboard.GetDataObject();
      // Checks whether the format of the data is 'UnicodeText' or not.
      if(myDataObject.GetDataPresent(DataFormats.UnicodeText)) 
      {
          Console.WriteLine("Data in 'UnicodeText' format:"+myDataObject.GetData(DataFormats.UnicodeText));
      } 
      else 
      {
          Console.WriteLine("No String information was contained in the clipboard.");
      }

      // Checks whether the format of the data is 'Text' or not.
      if(myDataObject.GetDataPresent(DataFormats.Text)) 
      {
          String clipString = (String)myDataObject.GetData(DataFormats.StringFormat);
          Console.WriteLine("Data in 'Text' format:"+clipString);
      }
  }
  catch(Exception e)
  {
      Console.WriteLine(e.Message);
  }

        Try
            Dim myString As String = "This is a String from the ClipBoard"
          
            ' Sets the data into the Clipboard.
            Clipboard.SetDataObject(myString)
            Dim myDataObject As IDataObject = Clipboard.GetDataObject()
            ' Checks whether the format of the data is 'UnicodeText' or not.
            If myDataObject.GetDataPresent(DataFormats.UnicodeText) Then
                Console.WriteLine($"Data in 'UnicodeText' format:{myDataObject.GetData(DataFormats.UnicodeText)}")
            Else
                Console.WriteLine("No String information was contained in the clipboard.")
            End If
          
            ' Checks whether the format of the data is 'Text' or not.
            If myDataObject.GetDataPresent(DataFormats.Text) Then
                Dim clipString As String = CType(myDataObject.GetData(DataFormats.StringFormat), String)
                Console.WriteLine($"Data in 'Text' format:{clipString}")
            End If
        Catch e As Exception
            Console.WriteLine(e.Message)
        End Try
    End Sub
End Class

Remarks

This field is used by the IDataObject interface and the DataObject class to specify the data type.

When adding to an IDataObject or to an implementation of DataObject, use this field as the format for the IDataObject.SetData and DataObject.SetData methods.

To see if an object of this type exists, use this field as the format for the IDataObject.GetDataPresent and DataObject.GetDataPresent methods.

To get an object of this type, use this as the format for the IDataObject.GetData and DataObject.GetData methods.

Applies to

Share via