Classes

Method DragDataObject():queryGetFormat() Foundation

Check whether a format is available for retrieval with :getData().

Syntax
:queryGetFormat( <nFormatId>   ) --> lAvail
:queryGetFormat( <cFormatName> ) --> lAvail
Parameters
<nFormatId>
<nFormat> is a numeric value that identifies the data format to be queried. It may be one of the following pre-defined format ids, or a custom format defined by the data provider.
Pre-defined data formats
Constant Description
XBPCLPBRD_TEXT Data in ASCII text format
XBPCLPBRD_BITMAP Graphic data in a bitmap format
XBPCLPBRD_METAFILE Graphic data in a meta file format
XBPCLPBRD_FILELIST List of files dragged over from the Windows Shell
<cFormatName>
<cFormatName> is a character string with the name of the format to be queried. Format names may vary with the operating system version installed, e.g. "File List", "FileName" or "Html".
Return

:queryGetData() returns a logical value that indicates whether the data can be retrieved in the format specified.

Description

The method :queryGetData() can be used to check whether the data encapsulated by the DragDataObject instance is available in a certain format. Often, the same data is available through a DragObject in several formats at once. An image may be retrieved as a bitmapped image or as a meta file. It is recommended to use :queryGetData()instead of making assumptions about the format the data can be retrieved in.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.