Adds an event listener.
Object
Guide
A guide.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Boolean | read/write | If true, the master page item can be overridden. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| 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. | |
| 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. | |
| GuideTypeOptions | read/write | The type of the guide. | |
| Number | String unit | read/write | The zone of the guide. | |
| Number | readonly | The unique ID of the Guide. | |
| Number | readonly | The index of the Guide within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| Layer | read/write | The layer that the Guide is on. | |
| String | read/write | A property that can be set to any string. | |
| Number | String unit | read/write | The location at which to place the guide relative to the current ruler zero point. | |
| Boolean | read/write | If true, the Guide is locked. | |
| String | read/write | The name of the Guide; this is an alias to the Guide's label property. | |
| HorizontalOrVertical | read/write | The orientation of the guide. | |
| 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. | |
| 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. | |
| MasterSpread | Spread | readonly | The parent of the Guide (a Spread or MasterSpread). | |
| Page | readonly | The page on which this page item appears. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| Number 5–4000 | read/write | The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0) |
Events
| Name | Description |
|---|---|
| Dispatched after a Guide is placed. This event bubbles. This event is not cancelable. |
Methods
→ void
Detaches an overridden master page item from the master page.
→ Guide
Duplicates the Guide.
→ String
Gets the label value associated with the specified key.
→ Guide[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
→ void
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.
→ Varies
Overrides a master page item and places the item on the document page as a new object.
→ void
Deletes the Guide.
→ Boolean
Removes the event listener.
→ void
Removes the override from a previously overridden master page item.
→ Varies
Get the coordinates of the given location in the specified coordinate system.
location
AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[]
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.
consideringRulerUnits?
Boolean
If 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.
→ void
Selects the object.
existingSelection?
SelectionOptions
The selection status of the Guide in relation to previously selected objects.
→ String
Generates a string which, if executed, will return the Guide.
→ String
Retrieves the object specifier.
Get the transformation values of the page item.
Object of 36
Properties elsewhere that hold a Guide.
Button.overriddenMasterPageItemCheckBox.overriddenMasterPageItemComboBox.overriddenMasterPageItemEPS.overriddenMasterPageItemEPSText.overriddenMasterPageItemEndnoteTextFrame.overriddenMasterPageItemEvent.parentEventListener.parentFlexObject.overriddenMasterPageItemFormField.overriddenMasterPageItemGraphic.overriddenMasterPageItemGraphicLine.overriddenMasterPageItemGroup.overriddenMasterPageItemGuide.overriddenMasterPageItemHtmlItem.overriddenMasterPageItemImage.overriddenMasterPageItemImportedPage.overriddenMasterPageItemListBox.overriddenMasterPageItemMediaItem.overriddenMasterPageItemMovie.overriddenMasterPageItemMultiStateObject.overriddenMasterPageItemMutationEvent.parentOval.overriddenMasterPageItemPDF.overriddenMasterPageItemPICT.overriddenMasterPageItemPageItem.overriddenMasterPageItemPolygon.overriddenMasterPageItemRadioButton.overriddenMasterPageItemRectangle.overriddenMasterPageItemSVG.overriddenMasterPageItemSignatureField.overriddenMasterPageItemSound.overriddenMasterPageItemSplineItem.overriddenMasterPageItemTextBox.overriddenMasterPageItemTextFrame.overriddenMasterPageItemWMF.overriddenMasterPageItem
Parameter of 3
Method parameters that accept a Guide.
Return 15
Methods that return a Guide.