Class
A guide. extractLabel, insertLabel, override, remove, removeOverride, select
Guide
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| fitToPage | bool | r/w | If true, horizontal orientation guides stop at the edges of the specified page. If false, the guides extends across the width of the spread and into the pasteboard area. |
| guideColor | 3 Reals (0 - 255) UIColors |
r/w | The color of the guide, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
| id | number | readonly | The unique ID of the Guide. |
| index | number | readonly | The index of the Guide within its containing object. |
| itemLayer | Layer | r/w | The layer that the Guide is on. |
| label | string | r/w | A property that can be set to any string. |
| location | Measurement Unit (Number or String) | r/w | The location at which to place the guide relative to the current ruler zero point. |
| locked | bool | r/w | If true, the Guide is locked. |
| orientation | HorizontalOrVertical: HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL |
r/w | The orientation of the guide. |
| parent | Document Layer MasterSpread Page Spread |
readonly | The parent of the Guide (a Page, Document, Layer, Spread or MasterSpread). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| viewThreshold | number | r/w | The guide's view threshold |
Methods
Instances
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
PageItem override (destinationPage:
Page)
Overrides a master page item and places it on the page
| Parameter | Type | Description |
|---|---|---|
| destinationPage | Page | The document page on which the master page item will be overridden. |
void remove ()
Deletes the Guide.
void removeOverride ()
Removes the override from a previously overridden master page item.
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE])
Select this object.
| Parameter | Type | Description |
|---|---|---|
| existingSelection | SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE | How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE) |
Return
Guide Guides.add ([layer: Layer][, withProperties: Object])
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |