Class

AnchoredObjectSetting

 The settings for an anchored object. Base Class: Preference

QuickLinks

addEventListener, getElements, insertAnchoredObject, releaseAnchoredObject, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Button | CheckBox | ComboBox | Document | EPSText | FormField | GraphicLine | Group | ListBox | MultiStateObject | ObjectStyle | Oval | Polygon | RadioButton | Rectangle | SignatureField | SplineItem | TextBox | TextFrame
Preference
AnchoredObjectSetting
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
anchorPointAnchorPoint:
AnchorPoint.TOP_LEFT_ANCHOR
AnchorPoint.TOP_CENTER_ANCHOR
AnchorPoint.TOP_RIGHT_ANCHOR
AnchorPoint.LEFT_CENTER_ANCHOR
AnchorPoint.CENTER_ANCHOR
AnchorPoint.RIGHT_CENTER_ANCHOR
AnchorPoint.BOTTOM_LEFT_ANCHOR
AnchorPoint.BOTTOM_CENTER_ANCHOR
AnchorPoint.BOTTOM_RIGHT_ANCHOR
r/wThe point in the anchored object to position.
anchorSpaceAboveMeasurement Unit (Number or String) r/wThe space above an above-line anchored object.
anchorXoffsetMeasurement Unit (Number or String) r/wThe horizontal (x) offset of the anchored object.
anchorYoffsetMeasurement Unit (Number or String) r/wThe vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning.
anchoredPositionAnchorPosition:
AnchorPosition.INLINE_POSITION
AnchorPosition.ABOVE_LINE
AnchorPosition.ANCHORED
r/wThe position of the anchored object relative to the anchor.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
horizontalAlignmentHorizontalAlignment:
HorizontalAlignment.RIGHT_ALIGN
HorizontalAlignment.LEFT_ALIGN
HorizontalAlignment.CENTER_ALIGN
HorizontalAlignment.TEXT_ALIGN
r/wWhen anchored position is above line, the position of the anchored object is relative to the text area. When anchored position is custom, the horizontal alignment of the anchored object is set by the horizontal reference point. Note: Not valid when anchored position is inline.
horizontalReferencePointAnchoredRelativeTo:
AnchoredRelativeTo.COLUMN_EDGE
AnchoredRelativeTo.TEXT_FRAME
AnchoredRelativeTo.PAGE_MARGINS
AnchoredRelativeTo.PAGE_EDGE
AnchoredRelativeTo.ANCHOR_LOCATION
r/wThe horizontal reference point on the page. Valid only when anchored position is custom.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
lockPositionbool r/wIf true, prevents manual positioning of the anchored object.
parentApplication
Button
CheckBox
ComboBox
Document
EPSText
FormField
GraphicLine
Group
ListBox
MultiStateObject
ObjectStyle
Oval
Polygon
RadioButton
Rectangle
SignatureField
SplineItem
TextBox
TextFrame
readonlyThe parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, Button, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject or ObjectStyle).
pinPositionbool r/wIf true, pins the position of the anchored object within the text frame top and bottom.
propertiesObject r/wA property that allows setting of several properties at the same time.
spineRelativebool r/wIf true, the position of the anchored object is relative to the binding spine of the page or spread.
verticalAlignmentVerticalAlignment:
VerticalAlignment.TOP_ALIGN
VerticalAlignment.BOTTOM_ALIGN
VerticalAlignment.CENTER_ALIGN
r/wThe vertical alignment of the anchored object reference point with the vertical reference point on the page. Notes: Valid only when anchored position is custom.
verticalReferencePointVerticallyRelativeTo:
VerticallyRelativeTo.COLUMN_EDGE
VerticallyRelativeTo.TEXT_FRAME
VerticallyRelativeTo.PAGE_MARGINS
VerticallyRelativeTo.PAGE_EDGE
VerticallyRelativeTo.LINE_BASELINE
VerticallyRelativeTo.LINE_XHEIGHT
VerticallyRelativeTo.LINE_ASCENT
VerticallyRelativeTo.CAPHEIGHT
VerticallyRelativeTo.TOP_OF_LEADING
VerticallyRelativeTo.EMBOX_TOP
VerticallyRelativeTo.EMBOX_MIDDLE
VerticallyRelativeTo.EMBOX_BOTTOM
r/wThe vertical reference point on the page. Valid when anchored position is custom.

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)

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

void insertAnchoredObject (storyOffset: InsertionPoint[, anchoredPosition: AnchorPosition])
Inserts the anchored object into specified story.

ParameterTypeDescription
storyOffsetInsertionPointThe location within the story, specified as an insertion point.
anchoredPositionAnchorPosition:
AnchorPosition.INLINE_POSITION
AnchorPosition.ABOVE_LINE
AnchorPosition.ANCHORED
The position of the anchored object relative to the anchor. (Optional)

void releaseAnchoredObject ()
Releases the anchored object from its associated text.

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)

string toSource ()
Generates a string which, if executed, will return the AnchoredObjectSetting.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.anchoredObjectSettings

Button.anchoredObjectSettings

CheckBox.anchoredObjectSettings

ComboBox.anchoredObjectSettings

Document.anchoredObjectSettings

EPSText.anchoredObjectSettings

FormField.anchoredObjectSettings

GraphicLine.anchoredObjectSettings

Group.anchoredObjectSettings

ListBox.anchoredObjectSettings

MultiStateObject.anchoredObjectSettings

ObjectStyle.anchoredObjectSettings

Oval.anchoredObjectSettings

Polygon.anchoredObjectSettings

RadioButton.anchoredObjectSettings

Rectangle.anchoredObjectSettings

SignatureField.anchoredObjectSettings

SplineItem.anchoredObjectSettings

TextBox.anchoredObjectSettings

TextFrame.anchoredObjectSettings

Return

Array of AnchoredObjectSetting AnchoredObjectSetting.getElements ()

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