Guide

Methods:

detach, duplicate, extractLabel, getElements, insertLabel, move, override, remove, removeOverride, select, toSource, toSpecifier

Objects:

Boolean, Graphic, Guide, HorizontalOrVertical, Layer, Movie, Number, Object, PageItem, Sound, String, UIColors,

Property Listing

Property	Type	Access	Description
allowOverrides	Boolean	read/write	If true, the master page item can be overridden.
fitToPage	Boolean	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.
guideColor	Array of 3 Reals (0 - 255) UIColors	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.
id	Number	readonly	The unique ID of the Guide.
index	Number	readonly	The index of the Guide within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	read/write	The layer that the Guide is on.
label	String	read/write	A property that can be set to any string.
location	Number String	read/write	The location at which to place the guide relative to the current ruler zero point.
locked	Boolean	read/write	If true, the Guide is locked.
orientation	HorizontalOrVertical HorizontalOrVertical.HORIZONTAL HorizontalOrVertical.VERTICAL	read/write	The orientation of the guide.
overridden	Boolean	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	Graphic Guide Movie PageItem Sound	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parent	Page	readonly	The parent of the Guide (a Page).
properties	Object	read/write	A property that allows setting of several properties at the same time.
viewThreshold	Number (range 5 - 4000)	read/write	The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)

Method Listing

undefined detach ()

Detaches an overridden master page item from the master page.

Guide duplicate ()

Duplicates the Guide.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Guide getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined move (to:Array of Number String, by:Array of Number String)

Moves the guide to a new location. Note: Either the to or the by parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of Number Array of String	The new location of the guide, in the format [x, y]. (Optional)
by	Array of Number Array of String	The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

Parameter

Type

Description

to

Array of Number

Array of String

The new location of the guide, in the format [x, y]. (Optional)

by

Array of Number

Array of String

The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

Varies override (destinationPage:Page)

Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

undefined remove ()

Deletes the Guide.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Guide in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Guide in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

String toSource ()

Generates a string which, if executed, will return the Guide.