DataFormats.GetFormat メソッド (String)

Windows クリップボード数値 ID および指定されたフォーマット名と共に DataFormats.Format を返します。

Overloads Public Shared Function GetFormat( _
   ByVal format As String _) As Format
[C#]
public static Format GetFormat(
   stringformat);
[C++]
public: static Format* GetFormat(
   String* format);
[JScript]
public static function GetFormat(
   format : String) : Format;

パラメータ

• format
  形式名

戻り値

Windows クリップボード数値 ID と形式名を持つ DataFormats.Format 。

例外

例外の種類	条件
Exception	新しい Clipboard 形式の登録に失敗しました。

解説

既存の形式の Windows クリップボード数値 ID が必要な場合は、形式名を使用して GetFormat を呼び出します。

このメソッドを独自の形式名で呼び出して、新しい種類の Clipboard 形式を作成します。存在しない形式を指定した場合、このメソッドはクリップボード形式として独自の形式名を Windows レジストリに登録し、一意の形式識別子を取得します。新しい名前と ID のペアが DataFormats クラスの形式名と ID のペアの静的 (Visual Basic では Shared) リストに追加されます。

使用例

[Visual Basic, C#, C++] 形式名と ID のペアを表す DataFormats.Format を取得する方法を次の例に示します。 UnicodeText 形式が要求され、取得された DataFormats.Format オブジェクトの内容がテキスト ボックスに表示されます。

[Visual Basic, C#, C++] このコードは、 textBox1 がインスタンス化されていることを前提にしています。

 
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


[C#] 
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;
}


[C++] 
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( S"ID value: {0}\nFormat name: {1}", __box(myFormat->Id), myFormat->Name );
 }
 

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

参照

DataFormats クラス | DataFormats メンバ | System.Windows.Forms 名前空間 | DataFormats.GetFormat オーバーロードの一覧 | DataFormats.Format