DataFormats.GetFormat Método

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Retorna um DataFormats.Format com o nome e a ID numérica da Área de Transferência do Windows.

Sobrecargas

GetFormat(Int32)	Retorna um DataFormats.Format com a ID numérica da Área de Transferência do Windows e o nome da ID especificada.
GetFormat(String)	Retorna um DataFormats.Format com a ID numérica da Área de Transferência do Windows e o nome do formato especificado.

GetFormat(Int32)

Origem:

DataFormats.cs

Retorna um DataFormats.Format com a ID numérica da Área de Transferência do Windows e o nome da ID especificada.

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

A ID do formato.

Retornos

DataFormats.Format

Um DataFormats.Format que tem a ID numérica da Área de Transferência do Windows e o nome do formato.

Exemplos

O exemplo de código a seguir demonstra o uso desse membro.

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

Comentários

Esse membro normalmente é usado para registrar formatos nativos da Área de Transferência.

Chame GetFormat com um número de ID quando quiser recuperar uma DataFormats.Format instância que contenha o par de nomes de ID/formato. Normalmente, o nome e o número da ID são publicados pelo criador do aplicativo com o qual você está usando o Clipboard para interface. Por exemplo, o número de ID para informações de conversa do DDE (Dynamic Data Exchange) no Visual Basic é &HBF00e o nome do formato é vbCFLink.

Chame esse método com qualquer número de ID exclusivo para adicionar o par de nomes de ID/formato à static lista de pares de nome/ID de formato na DataFormats classe . O novo nome será criado concatenando "Formato" e o número da ID. Esse par não está registrado como um novo Clipboard formato porque você não forneceu um nome.

Confira também

• DataFormats.Format

GetFormat(String)

Origem:

DataFormats.cs

Retorna um DataFormats.Format com a ID numérica da Área de Transferência do Windows e o nome do 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

O nome do formato.

Retornos

DataFormats.Format

Um DataFormats.Format que tem a ID numérica da Área de Transferência do Windows e o nome do formato.

Exceções

ArgumentException

.NET 5 e versões posteriores: format é null, Emptyou espaço em branco.

Win32Exception

Falha ao registrar um novo formato de Clipboard.

Exemplos

O exemplo de código a seguir mostra como recuperar um DataFormats.Format que representa um par de nome/ID de formato. O UnicodeText formato é solicitado e o conteúdo do recuperado DataFormats.Format é exibido em uma caixa de texto.

Esse código requer textBox1 que tenha sido instanciado.

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

Comentários

Chame GetFormat com o nome do formato quando precisar de uma ID numérica da Área de Transferência do Windows para um formato existente.

Chame esse método com seu próprio nome de formato para criar um novo Clipboard tipo de formato. Se o formato especificado não existir, esse método registrará o nome como um formato de Área de Transferência com o Registro do Windows e obterá um identificador de formato exclusivo. Esse novo par de nome/ID será adicionado à static lista de pares de nome/ID de formato na DataFormats classe .

Confira também

• DataFormats.Format