Returns an integer value indicating whether a specific format is on the DataObject.
Syntax
Boolean = object.GetFormat( format)
The GetFormat method syntax has these parts:
| Part | Description |
|---|---|
| object | Required. A valid object. |
| format | Required. An integer or string specifying a specific format that might exist in the DataObject. If the specified format exists in the DataObject, GetFormat returns True. |
Settings
The settings for format are:
| Value | Description |
|---|---|
| 1 | Text format. |
| A string or any integer other than 1 | A user-defined DataObject format passed to the DataObject from SetText. |
Remarks
The GetFormat method searches for a format in the current list of formats on the DataObject. If the format is on the DataObject, GetFormat returns True; if not, GetFormat returns False.
The DataObject currently supports only text formats.