DataFormats.GetDataFormat Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a DataFormat object that defines a name and numeric ID for the specified data format. The desired data format is specified by name (a string).

Namespace:   System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

[SecurityCriticalAttribute]
public static DataFormat GetDataFormat(
	string format
)

Parameters

format
Type: System.String

The name of the data format to request a DataFormat object for.

Return Value

Type: System.Windows.DataFormat

A DataFormat object that contains the numeric ID and the name of the requested data format.

Exception Condition
ArgumentNullException

format is null.

This method can also be used to register new formats. If the specified format cannot be found, it is automatically registered as a new data format.

Use of this method requires that the caller have UIPermission with the UIPermissionClipboard.AllClipboard

flag set. The following code shows the attribute syntax to request this permission for an assembly.

[assembly: SecurityPermissionAttribute(SecurityAction.RequestMinimum, Flags = UIPermissionClipboard.AllClipboard)]

UIPermission

for accessing low-level unmanaged code that supports the registration of clipboard formats. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 3.0
Return to top
Show: