DataFormats.GetFormat Método

Definição

Devolve um DataFormats.Format com o ID numérico e o nome do Windows Clipboard.

Sobrecargas

Name Description
GetFormat(Int32)

Devolve um DataFormats.Format com o ID numérico da Windows Clipboard e o nome do ID especificado.

GetFormat(String)

Devolve um DataFormats.Format com o ID numérico Windows do Clipboard e o nome para o formato especificado.

GetFormat(Int32)

Devolve um DataFormats.Format com o ID numérico da Windows Clipboard e o nome do ID 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

O ID do formato.

Devoluções

Um DataFormats.Format que tem o ID numérico da Windows Clipboard e o nome do formato.

Exemplos

O seguinte exemplo de código demonstra a utilização deste elemento.

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

Observações

Este membro é normalmente usado para registar formatos nativos de Clipboard.

Ligue GetFormat com um número de ID quando quiser recuperar uma DataFormats.Format instância que contenha o par ID/nome do formato. Normalmente, o nome e o número de identificação são publicados pelo criador da aplicação com a qual está Clipboard a usar para interagir. Por exemplo, o número ID para a informação de conversa Dynamic Data Exchange (DDE) no Visual Basic é &HBF00, e o nome do formato é vbCFLink.

Chame este método com qualquer número de ID único para adicionar o par ID/nome de formato à static lista de pares nome/ID de formato na DataFormats classe. O novo nome será criado concatenando "Format" e o número ID. Este par não está registado como um novo Clipboard formato porque não forneceu um nome.

Ver também

Aplica-se a

GetFormat(String)

Devolve um DataFormats.Format com o ID numérico Windows do Clipboard e o nome para o 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.

Devoluções

Um DataFormats.Format que tem o ID numérico da Windows Clipboard e o nome do formato.

Exceções

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

O registo de um novo Clipboard formato falhou.

Exemplos

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

Este código requer textBox1 foi 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

Observações

Ligue para GetFormat com o nome do formato quando precisar de um ID numérico Windows Clipboard para um formato existente.

Chame a este método com o seu próprio nome de formato para criar um novo Clipboard tipo de formato. Se o formato especificado não existir, este método regista o nome como formato Clipboard no registo do Windows e obtém um identificador de formato único. Este novo par nome/ID será adicionado à static lista de pares nome/ID de formato na DataFormats turma.

Ver também

Aplica-se a