DataFormats.GetFormat Método

Definición

Espacio de nombres:
System.Windows.Forms
Ensamblado:
System.Windows.Forms.dll

Devuelve un DataFormats.Format con el identificador numérico y el nombre del Portapapeles de Windows.

Sobrecargas

Nombre Description
GetFormat(Int32)

Devuelve un DataFormats.Format con el identificador numérico del Portapapeles de Windows y el nombre del identificador especificado.
GetFormat(String)

Devuelve un DataFormats.Format con el identificador numérico del Portapapeles Windows y el nombre del formato especificado.

GetFormat(Int32)

Devuelve un DataFormats.Format con el identificador numérico del Portapapeles de Windows y el nombre del identificador especificado.

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

Parámetros

id
Int32

Identificador de formato.

Devoluciones

DataFormats.Format

Un DataFormats.Format que tiene el identificador numérico del Portapapeles Windows y el nombre del formato.

Ejemplos

En el ejemplo de código siguiente se muestra el uso de este miembro.

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

Comentarios

Este miembro se usa normalmente para registrar formatos nativos del Portapapeles.

Llame GetFormat a con un número de identificador cuando desee recuperar una DataFormats.Format instancia que contenga el par id. o nombre de formato. Normalmente, el creador de la aplicación con la que se va a interactuar con el identificador y el número lo publica el creador de la aplicación con la Clipboard que se va a interactuar. Por ejemplo, el número de identificador de la información de conversación de Exchange de datos dinámicos (DDE) en Visual Basic es &HBF00 y el nombre de formato es vbCFLink.

Llame a este método con cualquier número de identificador único para agregar el par id. o nombre de formato a la static lista de pares de nombre/identificador de formato en la DataFormats clase . El nuevo nombre se creará concatenando "Format" y el número de identificador. Este par no está registrado como un nuevo Clipboard formato porque no ha proporcionado un nombre.

Consulte también

Se aplica a

GetFormat(String)

Devuelve un DataFormats.Format con el identificador numérico del Portapapeles Windows y el nombre del formato especificado.

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

Parámetros

format
String

Nombre de formato.

Devoluciones

DataFormats.Format

Un DataFormats.Format que tiene el identificador numérico del Portapapeles Windows y el nombre del formato.

Excepciones

ArgumentException

.NET 5 y versiones posteriores: format es null, Empty o espacio en blanco.

Win32Exception

Error al registrar un nuevo Clipboard formato.

Ejemplos

En el ejemplo de código siguiente se muestra cómo recuperar un DataFormats.Format elemento que representa un par de nombre o identificador de formato. Se solicita el UnicodeText formato y el contenido del recuperado DataFormats.Format se muestra en un cuadro de texto.

Se ha textBox1 creado una instancia de este código.

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

Comentarios

Llame a GetFormat con el nombre de formato cuando necesite un identificador numérico del Portapapeles de Windows para un formato existente.

Llame a este método con su propio nombre de formato para crear un nuevo Clipboard tipo de formato. Si el formato especificado no existe, este método registrará el nombre como un formato de Portapapeles con el registro de Windows y obtendrá un identificador de formato único. Este nuevo par nombre/identificador se agregará a la static lista de pares de nombre/identificador de formato en la DataFormats clase .

Consulte también

Se aplica a