Class

Guide

 A guide.

QuickLinks

addEventListener, detach, duplicate, extractLabel, getElements, insertLabel, move, override, remove, removeEventListener, removeOverride, resolve, select, toSource, toSpecifier, transformValuesOf

Hierarchy

MasterSpread | Spread
Guide
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allowOverridesbool r/wIf true, the master page item can be overridden.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fitToPagebool r/wIf 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.
guideColor3 Reals (0 - 255)
UIColors
r/wThe 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.
guideTypeGuideTypeOptions:
GuideTypeOptions.RULER
GuideTypeOptions.LIQUID
r/wThe type of the guide.
guideZoneMeasurement Unit (Number or String) r/wThe zone of the guide.
idnumber readonlyThe unique ID of the Guide.
indexnumber readonlyThe index of the Guide within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
itemLayerLayer r/wThe layer that the Guide is on.
labelstring r/wA property that can be set to any string.
locationMeasurement Unit (Number or String) r/wThe location at which to place the guide relative to the current ruler zero point.
lockedbool r/wIf true, the Guide is locked.
namestring r/wThe name of the Guide; this is an alias to the Guide's label property.
orientationHorizontalOrVertical:
HorizontalOrVertical.HORIZONTAL
HorizontalOrVertical.VERTICAL
r/wThe orientation of the guide.
overriddenbool readonlyIf 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.
overriddenMasterPageItemGraphic
Guide
Movie
PageItem
Sound
readonlyAn object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
parentMasterSpread
Spread
readonlyThe parent of the Guide (a Spread or MasterSpread).
parentPagePage readonlyThe page on which this page item appears.
propertiesObject r/wA property that allows setting of several properties at the same time.
viewThresholdnumber (range: 5 - 4000) r/wThe view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)

Class

PropertyTypeAccessDescription
AFTER_PLACEstring readonlyDispatched after a Guide is placed. This event bubbles. This event is not cancelable. (default: afterPlace)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
keystringThe key.

Array of Guide getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void move ([to: Array of Measurement Unit (Number or String)][, by: Array of Measurement Unit (Number or 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.

ParameterTypeDescription
toArray of Measurement Unit (Number or String)The new location of the guide, in the format [x, y]. (Optional)
byArray of Measurement Unit (Number or String)The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

any override (destinationPage: Page)
Overrides a master page item and places the item on the document page as a new object.

ParameterTypeDescription
destinationPagePageThe document page that contains the master page item to override.

void remove ()
Deletes the Guide.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

ParameterTypeDescription
locationAnchorPoint
AnchorPoint
Array of 2 Reals
Array of Arrays of 2 Reals
BoundingBoxLimits
CoordinateSpaces
Long Integers
The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use.
consideringRulerUnitsboolIf true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
SelectionOptions.SET_KEY
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.

string toSpecifier ()
Retrieves the object specifier.

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

ParameterTypeDescription
inCoordinateSpaces:
CoordinateSpaces.PASTEBOARD_COORDINATES
CoordinateSpaces.PARENT_COORDINATES
CoordinateSpaces.INNER_COORDINATES
CoordinateSpaces.PAGE_COORDINATES
CoordinateSpaces.SPREAD_COORDINATES
The coordinate space to use

Element of

Button.overriddenMasterPageItem

CheckBox.overriddenMasterPageItem

ComboBox.overriddenMasterPageItem

EPS.overriddenMasterPageItem

EPSText.overriddenMasterPageItem

FormField.overriddenMasterPageItem

Graphic.overriddenMasterPageItem

GraphicLine.overriddenMasterPageItem

Group.overriddenMasterPageItem

Guide.overriddenMasterPageItem

HtmlItem.overriddenMasterPageItem

Image.overriddenMasterPageItem

ImportedPage.overriddenMasterPageItem

ListBox.overriddenMasterPageItem

MediaItem.overriddenMasterPageItem

Movie.overriddenMasterPageItem

MultiStateObject.overriddenMasterPageItem

Oval.overriddenMasterPageItem

PDF.overriddenMasterPageItem

PICT.overriddenMasterPageItem

PageItem.overriddenMasterPageItem

Polygon.overriddenMasterPageItem

RadioButton.overriddenMasterPageItem

Rectangle.overriddenMasterPageItem

SignatureField.overriddenMasterPageItem

Sound.overriddenMasterPageItem

SplineItem.overriddenMasterPageItem

TextBox.overriddenMasterPageItem

TextFrame.overriddenMasterPageItem

WMF.overriddenMasterPageItem

Used in:

Guide Guides.nextItem (obj: Guide)

Guide Guides.previousItem (obj: Guide)

Return

Guide Guide.duplicate ()

Array of Guide Guide.getElements ()

Guide Guides.[] (index: number)

Guide Guides.add ([layer: Layer][, withProperties: Object])

Guide Guides.anyItem ()

Array of Guide Guides.everyItem ()

Guide Guides.firstItem ()

Guide Guides.item (index: varies)

Guide Guides.itemByID (id: number)

Guide Guides.itemByName (name: string)

Array of Guide Guides.itemByRange (from: varies, to: varies)

Guide Guides.lastItem ()

Guide Guides.middleItem ()

Guide Guides.nextItem (obj: Guide)

Guide Guides.previousItem (obj: Guide)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index