How to: List the Data Formats in a Data Object

The following examples show how to use the GetFormats method overloads get an array of strings denoting each data format that is available in a data object.

The following example code uses the GetFormats overload to get an array of strings denoting all data formats available in a data object (both native and auto-convertible).

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;
    }
}

The following example code uses the GetFormats overload to get an array of strings denoting only data formats available in a data object (auto-convertible data formats are filtered).

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;
    }
}
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft