Method XbpClipBoard():getFormatName() Foundation

Retrieves the name of a clipboard data format.

:getFormatName( <nFormatID> ) --> cName
<nFormatID> is a numeric value specifying a clipboard data format. This can either be a value returned from :registerFormat(), or one of the pre-defined clipboard data formats.

Return is a character string with the name of the clipboard data format. If the specified format does not exist, :getFormatName() returns an empty string ("").


The method :getFormatName() can be used to retrieve the human-readable name of a clipboard data format. If data in several formats is available in the clipboard, a prompt list can be created via :getFormatName(), for example. For more information on clipboard data formats, see the methods :getBuffer() and :registerFormat().


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.