DataFormats.GetFormat 方法

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

返回带有 Windows 剪贴板数字 ID 和名称的 DataFormats.Format。

重载

GetFormat(Int32)	为指定的 ID 返回带有 Windows 剪贴板数字 ID 和名称的 DataFormats.Format。
GetFormat(String)	为指定的格式返回带有 Windows 剪贴板数字 ID 和名称的 DataFormats.Format。

GetFormat(Int32)

为指定的 ID 返回带有 Windows 剪贴板数字 ID 和名称的 DataFormats.Format。

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

参数

id

Int32

格式 ID。

返回

DataFormats.Format

一个 DataFormats.Format，它具有 Windows 剪贴板数字 ID 和格式的名称。

示例

下面的代码示例演示了此成员的用法。

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

注解

此成员通常用于注册本机剪贴板格式。

如果要检索DataFormats.Format包含 ID/格式名称对的实例，请使用 ID 号调用GetFormat。 通常，ID 名称和编号由要 Clipboard 与之交互的应用程序的创建者发布。 例如，Visual Basic 中动态数据交换 (DDE) 会话信息的 ID 号为 &HBF00，格式名称为 vbCFLink。

使用任何唯一 ID 号调用此方法，将 ID/格式名称对添加到 static 类中的 DataFormats 格式名称/ID 对列表。 将通过串联“Format”和 ID 号来创建新名称。 此对未注册为新 Clipboard 格式，因为尚未提供名称。

另请参阅

• DataFormats.Format

GetFormat(String)

为指定的格式返回带有 Windows 剪贴板数字 ID 和名称的 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

参数

format

String

格式名。

返回

DataFormats.Format

一个 DataFormats.Format，它具有 Windows 剪贴板数字 ID 和格式的名称。

例外

ArgumentException

.NET 5 及更高版本： format 为 null、 Empty或空格。

Win32Exception

注册新的 Clipboard 格式失败。

示例

下面的代码示例演示如何检索 DataFormats.Format 表示格式名称/ID 对的 。 请求 UnicodeText 格式，检索到的内容 DataFormats.Format 将显示在文本框中。

此代码要求 textBox1 已实例化。

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

注解

如果需要现有格式的 Windows 剪贴板数字 ID，请使用格式名称调用 GetFormat 。

使用自己的格式名称调用此方法以创建新的 Clipboard 格式类型。 如果指定的格式不存在，此方法会将名称注册为 Windows 注册表的剪贴板格式，并获取唯一的格式标识符。 此新名称/ID 对将添加到 static 类中 DataFormats 格式名称/ID 对的列表。

另请参阅

• DataFormats.Format