clipboard GetFormatIndex method
Return to Introduction  Previous page  Next page
Applies to

function GetFormatIndex(const FormatName: String; RegisterIfNotAvailable: Boolean = False): Integer;  

The GetFormatIndex property returns the index of the clipboard format by its name.  
If the specified format name is not registered in the system, and RegisterIfNotAvailable parameter is True, the function registers new format and returns the index of registered format. Otherwise, if the specified FormatName does not exists, the function returns 0.  
tip To receive the list of all formats that currently are available in the clipboard — read AvailableFormats property.  

See also
AvailableFormats property;  
HasFormat and GetFormatName methods.