DataObject.GetFormats メソッド

定義

このデータ オブジェクトのデータが格納される形式、またはこのデータの変換先として有効な形式のリストを返します。

オーバーロード

GetFormats()

このデータ オブジェクトのデータが格納される形式、またはこのデータの変換先として有効な形式のリストを返します。

GetFormats(Boolean)

このデータ オブジェクトのデータが格納される形式のリストを返します。 Boolean フラグは、データの自動変換先として有効な形式も含めるかどうかを示します。

GetFormats()

このデータ オブジェクトのデータが格納される形式、またはこのデータの変換先として有効な形式のリストを返します。

public:
 virtual cli::array <System::String ^> ^ GetFormats();
public string[] GetFormats ();
abstract member GetFormats : unit -> string[]
override this.GetFormats : unit -> string[]
Public Function GetFormats () As String()

戻り値

String[]

文字列の配列。各文字列で、該当するデータ オブジェクトがサポートする形式の名前を指定します。

実装

次の例では、このメソッドを使用して、データ オブジェクトで使用できるすべてのデータ形式 (ネイティブと自動変換の両方) を示す文字列の配列を取得します。

DataObject dataObject = new DataObject("Some string data to store...");

// Get an array of strings, each string denoting a data format
// that is available in the data object.  This overload of GetDataFormats
// returns all available data formats, native and auto-convertible.
string[] dataFormats = dataObject.GetFormats();

// Get the number of data formats present in the data object, including both
// auto-convertible and native data formats.
int numberOfDataFormats = dataFormats.Length;

// To enumerate the resulting array of data formats, and take some action when
// a particular data format is found, use a code structure similar to the following.
foreach (string dataFormat in dataFormats)
{
    if (dataFormat == DataFormats.Text)
    {
        // Take some action if/when data in the Text data format is found.
        break;
    }
    else if(dataFormat == DataFormats.StringFormat)
    {
        // Take some action if/when data in the string data format is found.
        break;
    }
}
Dim dataObject As New DataObject("Some string data to store...")

' Get an array of strings, each string denoting a data format
' that is available in the data object.  This overload of GetDataFormats
' returns all available data formats, native and auto-convertible.
Dim dataFormats() As String = dataObject.GetFormats()

' Get the number of data formats present in the data object, including both
' auto-convertible and native data formats.
Dim numberOfDataFormats As Integer = dataFormats.Length

' To enumerate the resulting array of data formats, and take some action when
' a particular data format is found, use a code structure similar to the following.
For Each dataFormat As String In dataFormats
    If dataFormat = System.Windows.DataFormats.Text Then
        ' Take some action if/when data in the Text data format is found.
        Exit For
    ElseIf dataFormat = System.Windows.DataFormats.StringFormat Then
        ' Take some action if/when data in the string data format is found.
        Exit For
    End If
Next dataFormat

注釈

定義済みのデータ形式のセットについては、DataFormats クラスを参照してください。

適用対象

GetFormats(Boolean)

このデータ オブジェクトのデータが格納される形式のリストを返します。 Boolean フラグは、データの自動変換先として有効な形式も含めるかどうかを示します。

public:
 virtual cli::array <System::String ^> ^ GetFormats(bool autoConvert);
public string[] GetFormats (bool autoConvert);
abstract member GetFormats : bool -> string[]
override this.GetFormats : bool -> string[]
Public Function GetFormats (autoConvert As Boolean) As String()

パラメーター

autoConvert
Boolean

このデータ オブジェクトのデータが格納されるすべての形式、およびこのデータの変換先として有効なすべての形式を取得する場合は true。このデータ オブジェクトのデータが格納される形式のみを取得する場合は false

戻り値

String[]

文字列の配列です。各文字列で、該当するデータ オブジェクトがサポートする形式の名前を指定します。

実装

次の例では、このメソッドを使用して、データ オブジェクトで使用できるデータ形式のみを示す文字列の配列を取得します (自動変換可能なデータ形式はフィルター処理されます)。

DataObject dataObject = new DataObject("Some string data to store...");

// Get an array of strings, each string denoting a data format
// that is available in the data object.  This overload of GetDataFormats
// accepts a Boolean parameter inidcating whether to include auto-convertible
// data formats, or only return native data formats.
string[] dataFormats = dataObject.GetFormats(false /* Include auto-convertible? */);

// Get the number of native data formats present in the data object.
int numberOfDataFormats = dataFormats.Length;

// To enumerate the resulting array of data formats, and take some action when
// a particular data format is found, use a code structure similar to the following.
foreach (string dataFormat in dataFormats)
{
    if (dataFormat == DataFormats.Text)
    {
        // Take some action if/when data in the Text data format is found.
        break;
    }
}
Dim dataObject As New DataObject("Some string data to store...")

' Get an array of strings, each string denoting a data format
' that is available in the data object.  This overload of GetDataFormats
' accepts a Boolean parameter inidcating whether to include auto-convertible
' data formats, or only return native data formats.
Dim dataFormats() As String = dataObject.GetFormats(False) ' Include auto-convertible? 

' Get the number of native data formats present in the data object.
Dim numberOfDataFormats As Integer = dataFormats.Length

' To enumerate the resulting array of data formats, and take some action when
' a particular data format is found, use a code structure similar to the following.
For Each dataFormat As String In dataFormats
    If dataFormat = System.Windows.DataFormats.Text Then
        ' Take some action if/when data in the Text data format is found.
        Exit For
    End If
Next dataFormat

注釈

定義済みのデータ形式のセットについては、DataFormats クラスを参照してください。

適用対象