InDesign2026
API 21.5.1.73
Object

AnchoredObjectSetting

The settings for an anchored object.

Preference AnchoredObjectSetting

Properties

NameType AccessDescription
AnchorPoint
read/write The point in the anchored object to position.
Number | String unit read/write The space above an above-line anchored object.
Number | String unit read/write The horizontal (x) offset of the anchored object.
Number | String unit read/write The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning.
AnchorPosition
read/write The position of the anchored object relative to the anchor.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
HorizontalAlignment
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.
AnchoredRelativeTo
read/write The horizontal reference point on the page. Valid only when anchored position is custom.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Boolean read/write If true, prevents manual positioning of the anchored object.
Application | Button | CheckBox | ComboBox | Document | EPSText | EndnoteTextFrame | FormField | GraphicLine | Group | ListBox | MultiStateObject | Oval | Polygon | RadioButton | Rectangle | SignatureField | SplineItem | TextBox | TextFrame | FlexObject | ObjectStyle readonly The parent of the AnchoredObjectSetting (a FlexObject, Application, Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, TextFrame, EndnoteTextFrame, Button, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject or ObjectStyle).
Boolean read/write If true, pins the position of the anchored object within the text frame top and bottom.
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write If true, the position of the anchored object is relative to the binding spine of the page or spread.
VerticalAlignment
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.
VerticallyRelativeTo
read/write The vertical reference point on the page. Valid when anchored position is custom.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
AnchoredObjectSetting[]

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

void

Inserts the anchored object into specified story.

storyOffset InsertionPoint The location within the story, specified as an insertion point.
anchoredPosition? AnchorPosition The position of the anchored object relative to the anchor.
void

Releases the anchored object from its associated text.

Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 25

Properties elsewhere that hold a AnchoredObjectSetting.

Return 1

Methods that return a AnchoredObjectSetting.