Teilen über


DataFormats.GetFormat Methode

Definition

Gibt ein DataFormats.Format der Windows-Zwischenablage mit der numerischen ID und dem Namen zurück.

Überlädt

GetFormat(Int32)

Gibt ein DataFormats.Format der Windows-Zwischenablage mit der numerischen ID und dem entsprechenden Namen zurück.

GetFormat(String)

Gibt ein DataFormats.Format der Windows-Zwischenablage mit der numerischen ID und dem Namen für das angegebene Format zurück.

GetFormat(Int32)

Gibt ein DataFormats.Format der Windows-Zwischenablage mit der numerischen ID und dem entsprechenden Namen zurück.

public:
 static System::Windows::Forms::DataFormats::Format ^ GetFormat(int id);
public static System.Windows.Forms.DataFormats.Format GetFormat (int id);
static member GetFormat : int -> System.Windows.Forms.DataFormats.Format
Public Shared Function GetFormat (id As Integer) As DataFormats.Format

Parameter

id
Int32

Die Format-ID.

Gibt zurück

Ein DataFormats.Format, das die von der Windows-Zwischenablage verwendete numerische ID und den Formatnamen aufweist.

Beispiele

Im folgenden Codebeispiel wird die Verwendung dieses Members veranschaulicht.

using namespace System;
using namespace System::Windows::Forms;
int main()
{
   
   // Create a DataFormats::Format for the Unicode data format.
   DataFormats::Format^ myFormat = DataFormats::GetFormat( 13 );
   
   // Display the contents of myFormat.
   Console::WriteLine( "The Format Name corresponding to the ID {0} is :", myFormat->Id );
   Console::WriteLine( myFormat->Name );
}
using System;
using System.Windows.Forms;

   public class DataFormat_GetFormat
   {
      static void Main()
      {

         // Create a DataFormats.Format for the Unicode data format.
         DataFormats.Format myFormat = DataFormats.GetFormat(13);

         // Display the contents of myFormat.
         Console.WriteLine("The Format Name corresponding to the ID "+myFormat.Id+" is :");
         Console.WriteLine(myFormat.Name);
      }
   }
Imports System.Windows.Forms

Public Class DataFormat_GetFormat
   
   Shared Sub Main()
      
     ' Create a DataFormats.Format for the Unicode data format.

      Dim myFormat As DataFormats.Format = DataFormats.GetFormat(13)

      ' Display the contents of myFormat.

      Console.WriteLine(("The Format Name corresponding to the ID " + myFormat.Id.ToString + " is :"))
      Console.WriteLine(myFormat.Name)

   End Sub

End Class

Hinweise

Dieser Member wird in der Regel verwendet, um native Zwischenablageformate zu registrieren.

Rufen Sie GetFormat mit einer ID-Nummer auf, wenn Sie eine DataFormats.Format instance abrufen möchten, die das ID/Format-Namenspaar enthält. In der Regel werden der ID-Name und die Nummer vom Ersteller der Anwendung veröffentlicht, mit der Sie die Clipboard Schnittstelle verwenden. Beispielsweise lautet &HBF00die ID-Nummer für DDE-Konversationsinformationen (Dynamic Data Exchange) in Visual Basic , und der Formatname lautet vbCFLink.

Rufen Sie diese Methode mit einer beliebigen eindeutigen ID-Nummer auf, um das ID/Format-Name-Paar der Liste der static Formatnamen-/ID-Paare in der DataFormats Klasse hinzuzufügen. Der neue Name wird erstellt, indem "Format" und die ID-Nummer verkettet werden. Dieses Paar wird nicht als neues Clipboard Format registriert, da Sie keinen Namen angegeben haben.

Weitere Informationen

Gilt für:

GetFormat(String)

Gibt ein DataFormats.Format der Windows-Zwischenablage mit der numerischen ID und dem Namen für das angegebene Format zurück.

public:
 static System::Windows::Forms::DataFormats::Format ^ GetFormat(System::String ^ format);
public static System.Windows.Forms.DataFormats.Format GetFormat (string format);
static member GetFormat : string -> System.Windows.Forms.DataFormats.Format
Public Shared Function GetFormat (format As String) As DataFormats.Format

Parameter

format
String

Der Formatname.

Gibt zurück

Ein DataFormats.Format, das die von der Windows-Zwischenablage verwendete numerische ID und den Formatnamen aufweist.

Ausnahmen

.NET 5 und höhere Versionen: format ist null, Emptyoder Leerraum.

Fehler beim Registrieren eines neuen Clipboard-Formats.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein DataFormats.Format Formatnamen/ID-Paar abgerufen wird. Das UnicodeText Format wird angefordert, und der Inhalt des abgerufenen DataFormats.Format wird in einem Textfeld angezeigt.

Dieser code requires textBox1 wurde instanziiert.

private:
   void GetMyFormatInfomation()
   {
      // Creates a DataFormats.Format for the Unicode data format.
      DataFormats::Format^ myFormat = DataFormats::GetFormat(
         DataFormats::UnicodeText );
      
      // Displays the contents of myFormat.
      textBox1->Text = String::Format( "ID value: {0}\nFormat name: {1}",
         myFormat->Id, myFormat->Name );
   }
private void GetMyFormatInfomation() {
   // Creates a DataFormats.Format for the Unicode data format.
   DataFormats.Format myFormat = DataFormats.GetFormat(DataFormats.UnicodeText);

   // Displays the contents of myFormat.
   textBox1.Text = "ID value: " + myFormat.Id + '\n' +
      "Format name: " + myFormat.Name;
}
Private Sub GetMyFormatInfomation()
    ' Creates a DataFormats.Format for the Unicode data format.
    Dim myFormat As DataFormats.Format = _
       DataFormats.GetFormat(DataFormats.UnicodeText)
       
    ' Displays the contents of myFormat.
    textBox1.Text = "ID value: " + myFormat.Id.ToString() + ControlChars.Cr _
                  + "Format name: " + myFormat.Name
End Sub

Hinweise

Rufen Sie GetFormat mit dem Formatnamen auf, wenn Sie eine numerische Windows-Zwischenablage-ID für ein vorhandenes Format benötigen.

Rufen Sie diese Methode mit Ihrem eigenen Formatnamen auf, um einen neuen Clipboard Formattyp zu erstellen. Wenn das angegebene Format nicht vorhanden ist, registriert diese Methode den Namen als Zwischenablageformat bei der Windows-Registrierung und ruft einen eindeutigen Formatbezeichner ab. Dieses neue Name/ID-Paar wird der Liste der static Formatnamen-ID-Paare in der DataFormats Klasse hinzugefügt.

Weitere Informationen

Gilt für: