A guide.
Go to Property Listing | Method Listing
extractLabel, insertLabel, override, remove, removeOverride, select
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
read/write |
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. |
||
|
Array of 3 Reals (0 - 255) |
read/write |
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. |
|
|
readonly |
The unique ID of the Guide. |
||
|
readonly |
The index of the Guide within its containing object. |
||
|
read/write |
The layer that the Guide is on. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The location at which to place the guide relative to the current ruler zero point. |
||
|
read/write |
If true, the Guide is locked. |
||
|
read/write |
The orientation of the guide. |
||
|
readonly |
The parent of the Guide (a Page, Spread, MasterSpread, Document or Layer). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
The guide's view threshold |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
PageItem override (destinationPage:Page)
Overrides a master page item and places it on the page
|
Parameter |
Type |
Description |
|---|---|---|
|
destinationPage |
The document page on which the master page item will be overridden. |
undefined remove ()
Deletes the Guide.
undefined removeOverride ()
Removes the override from a previously overridden master page item.
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Select this object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE) |