GetThemeIcons()
Summary
Gets the list of icons that are used to draw a theme.
Changes
In Version 2014 added Color Bitmap as a type of icon.
Syntax
icns = GetThemeIcons(string theme_name)
| Argument | Contents |
|---|---|
| theme_name | The name of a theme on the current layer |
Returns
An array of icon definitions, one for each class in the theme. Each icon definition is an array of three elements:
| Element | Type | Contents |
|---|---|---|
| type | String | A string indicating the type of icon: "Font Character" or "Color Bitmap" |
| name | String | The name of a TrueType font (including size and style), or the name of the bitmap file |
| index | Real | Index of a character in the font, or size of the bitmap in points |
Notes
-
A null entry in the returned array indicates that the objects in the corresponding class are drawn with the icon settings of the underlying layer.
-
If the theme contains an Other class, its icon is the first element of the array.
Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified theme does not exist on the current layer |
See Also
| Function | Summary |
|---|---|
| SetThemeIcons() | Sets the icons for a given theme |
| GetThemeIconColors() | Gets the list of icon colors that are used to draw a theme |