AnchoredObjectSetting

Methods:

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

Objects:

AnchorPoint, AnchorPosition, AnchoredRelativeTo, Boolean, EventListeners, Events, HorizontalAlignment, Number, Object, String, VerticalAlignment, VerticallyRelativeTo

Hierarchy:

Superclass: Preference

Class: AnchoredObjectSetting

Property Listing

Property	Type	Access	Description
anchorPoint	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	read/write	The point in the anchored object to position.
anchorSpaceAbove	Number String	read/write	The space above an above-line anchored object.
anchorXoffset	Number String	read/write	The horizontal (x) offset of the anchored object.
anchorYoffset	Number String	read/write	The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning.
anchoredPosition	AnchorPosition AnchorPosition.ABOVE_LINE AnchorPosition.ANCHORED AnchorPosition.INLINE_POSITION	read/write	The position of the anchored object relative to the anchor.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
horizontalAlignment	HorizontalAlignment HorizontalAlignment.CENTER_ALIGN HorizontalAlignment.LEFT_ALIGN HorizontalAlignment.RIGHT_ALIGN HorizontalAlignment.TEXT_ALIGN	read/write	When 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.
horizontalReferencePoint	AnchoredRelativeTo AnchoredRelativeTo.ANCHOR_LOCATION AnchoredRelativeTo.COLUMN_EDGE AnchoredRelativeTo.PAGE_EDGE AnchoredRelativeTo.PAGE_MARGINS AnchoredRelativeTo.TEXT_FRAME	read/write	The horizontal reference point on the page. Valid only when anchored position is custom.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
lockPosition	Boolean	read/write	If true, prevents manual positioning of the anchored object.
parent	Button CheckBox ComboBox Document EPSText EndnoteTextFrame FormField GraphicLine Group ListBox MultiStateObject Oval Polygon RadioButton Rectangle SignatureField SplineItem TextBox TextFrame Application ObjectStyle	readonly	The parent of the AnchoredObjectSetting (a Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, EndnoteTextFrame, Button, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject or ObjectStyle).
pinPosition	Boolean	read/write	If true, pins the position of the anchored object within the text frame top and bottom.
properties	Object	read/write	A property that allows setting of several properties at the same time.
spineRelative	Boolean	read/write	If true, the position of the anchored object is relative to the binding spine of the page or spread.
verticalAlignment	VerticalAlignment VerticalAlignment.BOTTOM_ALIGN VerticalAlignment.CENTER_ALIGN VerticalAlignment.TOP_ALIGN	read/write	The vertical alignment of the anchored object reference point with the vertical reference point on the page. Notes: Valid only when anchored position is custom.
verticalReferencePoint	VerticallyRelativeTo VerticallyRelativeTo.CAPHEIGHT VerticallyRelativeTo.COLUMN_EDGE VerticallyRelativeTo.EMBOX_BOTTOM VerticallyRelativeTo.EMBOX_MIDDLE VerticallyRelativeTo.EMBOX_TOP VerticallyRelativeTo.LINE_ASCENT VerticallyRelativeTo.LINE_BASELINE VerticallyRelativeTo.LINE_XHEIGHT VerticallyRelativeTo.PAGE_EDGE VerticallyRelativeTo.PAGE_MARGINS VerticallyRelativeTo.TEXT_FRAME VerticallyRelativeTo.TOP_OF_LEADING	read/write	The vertical reference point on the page. Valid when anchored position is custom.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

AnchoredObjectSetting getElements ()

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

undefined insertAnchoredObject (storyOffset:InsertionPoint, anchoredPosition:AnchorPosition)

Inserts the anchored object into specified story.

Parameter	Type	Description
storyOffset	InsertionPoint	The location within the story, specified as an insertion point.
anchoredPosition	AnchorPosition AnchorPosition.ABOVE_LINE AnchorPosition.ANCHORED AnchorPosition.INLINE_POSITION	The position of the anchored object relative to the anchor. (Optional)

Parameter

Type

Description

storyOffset

InsertionPoint

The location within the story, specified as an insertion point.

anchoredPosition

AnchorPosition

AnchorPosition.ABOVE_LINE

AnchorPosition.ANCHORED

AnchorPosition.INLINE_POSITION

The position of the anchored object relative to the anchor. (Optional)

undefined releaseAnchoredObject ()

Releases the anchored object from its associated text.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.anchoredObjectSettings

Document.anchoredObjectSettings

FormField.anchoredObjectSettings

Button.anchoredObjectSettings

MultiStateObject.anchoredObjectSettings

CheckBox.anchoredObjectSettings

ComboBox.anchoredObjectSettings

ListBox.anchoredObjectSettings

RadioButton.anchoredObjectSettings

TextBox.anchoredObjectSettings

SignatureField.anchoredObjectSettings

Oval.anchoredObjectSettings

Rectangle.anchoredObjectSettings

GraphicLine.anchoredObjectSettings

Polygon.anchoredObjectSettings

Group.anchoredObjectSettings

SplineItem.anchoredObjectSettings

EPSText.anchoredObjectSettings

ObjectStyle.anchoredObjectSettings

TextFrame.anchoredObjectSettings

EndnoteTextFrame.anchoredObjectSettings

Event.parent

EventListener.parent

MutationEvent.parent

Return

AnchoredObjectSetting.getElements()