DataFormats.GetFormat Metoda

Definice

DataFormats.Format Vrátí hodnotu s číselným ID a názvem schránky Windows.

Přetížení

GetFormat(Int32)

DataFormats.Format Vrátí hodnotu s číselným ID schránky systému Windows a názvem zadaného ID.

GetFormat(String)

Vrátí hodnotu DataFormats.Format s číselným ID a názvem schránky systému Windows pro zadaný formát.

GetFormat(Int32)

DataFormats.Format Vrátí hodnotu s číselným ID schránky systému Windows a názvem zadaného ID.

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

Parametry

id
Int32

ID formátu.

Návraty

A DataFormats.Format , který má číselné ID schránky Systému Windows a název formátu.

Příklady

Následující příklad kódu ukazuje použití tohoto člena.

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

Poznámky

Tento člen se obvykle používá k registraci nativních formátů schránky.

Pokud GetFormat chcete načíst DataFormats.Format instanci, která obsahuje dvojici ID/formát názvu, zavolejte s číslem ID. Název ID a číslo obvykle publikuje tvůrce aplikace, se kterou používáte Clipboard rozhraní. Například číslo ID pro informace o konverzaci dynamické výměny dat (DDE) v jazyce Visual Basic je &HBF00a název formátu je vbCFLink.

Voláním této metody s libovolným jedinečným číslem ID přidáte dvojici název/název formátu do static seznamu dvojic název/ID formátu ve DataFormats třídě. Nový název se vytvoří zřetězením "Formát" a čísla ID. Tato dvojice není zaregistrovaná jako nový Clipboard formát, protože jste nezadáli název.

Viz také

Platí pro

GetFormat(String)

Vrátí hodnotu DataFormats.Format s číselným ID a názvem schránky systému Windows pro zadaný formát.

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

Parametry

format
String

Název formátu.

Návraty

A DataFormats.Format , který má číselné ID schránky Systému Windows a název formátu.

Výjimky

.NET 5 a novější verze: format je null, Emptynebo prázdné znaky.

Registrace nového Clipboard formátu se nezdařila.

Příklady

Následující příklad kódu ukazuje, jak načíst dvojici DataFormats.Format název/ID formátu. Vyžaduje se UnicodeText formát a obsah načteného DataFormats.Format se zobrazí v textovém poli.

Tento kód vyžaduje textBox1 vytvoření instance.

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

Poznámky

Pokud potřebujete číselné ID schránky Windows pro existující formát, volejte GetFormat s názvem formátu.

Voláním této metody s vlastním názvem formátu vytvořte nový Clipboard typ formátu. Pokud zadaný formát neexistuje, tato metoda zaregistruje název jako formát schránky v registru systému Windows a získá jedinečný identifikátor formátu. Tato nová dvojice název/ID bude přidána static do seznamu dvojic název/ID formátu ve DataFormats třídě.

Viz také

Platí pro