DataFormats.GetFormat Méthode

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

Paramètres

Retours

DataFormats.Format portant le nom de format et le numéro d'ID du Presse-papiers Windows.

Exemples

L’exemple de code suivant illustre l’utilisation de ce membre.

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

Remarques

Ce membre est généralement utilisé pour inscrire les formats natifs du Presse-papiers.

Appelez GetFormat avec un numéro d’ID lorsque vous souhaitez récupérer un DataFormats.Format instance qui contient la paire id/nom de format. En règle générale, le nom et le numéro d’ID sont publiés par le créateur de l’application avec laquelle vous utilisez l’interface Clipboard . Par exemple, le numéro d’ID des informations de conversation DDE (Dynamic Data Exchange) en Visual Basic est &HBF00, et le nom du format est vbCFLink.

Appelez cette méthode avec n’importe quel numéro d’ID unique pour ajouter la paire ID/nom de format à la static liste des paires nom de format/ID dans la DataFormats classe. Le nouveau nom sera créé en concaténant « Format » et le numéro d’ID. Cette paire n’est pas inscrite dans un nouveau Clipboard format, car vous n’avez pas fourni de nom.

Voir aussi

• DataFormats.Format

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

Paramètres

Retours

DataFormats.Format portant le nom de format et le numéro d'ID du Presse-papiers Windows.

Exceptions

Exemples

L’exemple de code suivant montre comment récupérer un représentant une DataFormats.Format paire nom/ID de format. Le UnicodeText format est demandé et le contenu du récupéré DataFormats.Format s’affiche dans une zone de texte.

Ce code requis textBox1 a été instancié.

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

Remarques

Appelez GetFormat avec le nom de format lorsque vous avez besoin d’un ID numérique du Presse-papiers Windows pour un format existant.

Appelez cette méthode avec votre propre nom de format pour créer un nouveau Clipboard type de format. Si le format spécifié n’existe pas, cette méthode inscrit le nom au format Presse-papiers auprès du Registre Windows et obtient un identificateur de format unique. Cette nouvelle paire nom/ID sera ajoutée à la static liste des paires nom/ID de format dans la DataFormats classe.

Voir aussi

• DataFormats.Format