A guide.
guide properties
| Property | Type | Access | Description |
|---|---|---|---|
| class | integer | read | The class descriptor type. |
| fit to page | boolean | r/w | If false, a horizontal guide will extend across all pages in the spread. |
| guide color | list of 3 fixed (0 – 255), UI colors enumeration | r/w | The color of the guide. |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| item layer | layer | r/w | The layer the object is on. |
| label | string | r/w | A label that can be set to any string. |
| location | number or string | r/w | The location of the guide. |
| locked | boolean | r/w | If true, the object is locked. |
| object reference | object | read | An object reference for this object. |
| orientation | horizontal or vertical enumeration | r/w | The guide’s orientation. |
| overridden | boolean | read | If true, this object originated on a master spread, was overridden, and is still linked to the object on the master spread. |
| overridden master page item | page item, guide, graphic, movie, sound | read | A reference to the original object on the master spread (for overridden objects). |
| parent | object | read | The parent of the object. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| view threshold | fixed (5 – 4000) | r/w | The guide’s view threshold. |
guide methods
| Method | Returns | Description |
|---|---|---|
| delete | Nothing | Delete the object. |
| detach | Nothing | Detaches an overridden page item from the master page item. |
| duplicate | object | Duplicates the object. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| move | Nothing | Moves the guide. |
| override | page item, guide, graphic, movie or sound | Overrides an item from the master page and places it on the page. |
| remove override | Nothing | Removes a locally overridden master page item. |
| select | Nothing | Selects the object. |