Guide
A guide.
Guide Properties
| Property |
Type |
Access |
Description |
| FitToPage |
Boolean |
r/w |
If false, a horizontal guide will extend across all pages in the spread. |
| GuideColor |
Array of 3 Doubles (0 – 255), idUIColors enumeration (see table at end of chapter) |
r/w |
The color of the guide. |
| Id |
Long |
read |
A unique number identifying the object. |
| Index |
Long |
read |
Index of the object within its parent object. |
| ItemLayer |
Layer |
r/w |
The layer the object is on. |
| Label |
String |
r/w |
A label that can be set to any string. |
| Location |
Unit (Double or String) |
r/w |
The location of the guide. |
| Locked |
Boolean |
r/w |
If true, the object is locked. |
| Orientation |
idHorizontalOrVertical 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. |
| OverriddenMasterPageItem |
PageItem, 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. |
| ViewThreshold |
Double (5 – 4000) |
r/w |
The guide’s view threshold. |
Guide Methods
| Method |
Returns |
Description |
| Delete |
Nothing |
Deletes the object. |
| Detach |
Nothing |
Detaches an overridden page item from the master page item. |
| Duplicate |
Object |
Duplicates the object. |
| ExtractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| InsertLabel |
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 |
PageItem, Guide, Graphic, Movie or Sound |
Overrides an item from the master page and places it on the page. |
| RemoveOverride |
Nothing |
Removes a locally overridden master page item. |
| Select |
Nothing |
Selects the object. |
Previous post: GuidePreference
Next post: Groups