AnchoredObjectSetting

The settings for an anchored object.

Properties

Property Type Access Description
anchoredPosition AnchorPosition
:
INLINE_POSITION
ABOVE_LINE
ANCHORED
r/w The position of the anchored object relative to the anchor.
anchorPoint AnchorPoint
:
TOP_LEFT_ANCHOR
TOP_CENTER_ANCHOR
TOP_RIGHT_ANCHOR
LEFT_CENTER_ANCHOR
CENTER_ANCHOR
RIGHT_CENTER_ANCHOR
BOTTOM_LEFT_ANCHOR
BOTTOM_CENTER_ANCHOR
BOTTOM_RIGHT_ANCHOR
r/w The point in the anchored object to position.
anchorSpaceAbove number r/w The space above an above-line anchored object.
anchorXoffset number r/w The horizontal (x) offset of the anchored object.
anchorYoffset number r/w The vertical (y) offset of the anchored object.
horizontalAlignment HorizontalAlignment
:
RIGHT_ALIGN
LEFT_ALIGN
CENTER_ALIGN
TEXT_ALIGN
r/w 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
:
COLUMN_EDGE
TEXT_FRAME
PAGE_MARGINS
PAGE_EDGE
ANCHOR_LOCATION
r/w The horizontal reference point on the page. Valid only when anchored position is custom.
lockPosition bool r/w If true, prevents manual positioning of the anchored object.
parent any readonly The parent of the AnchoredObjectSetting (a PageItem, Oval, Rectangle, GraphicLine, Polygon, Group, TextFrame, FormField, Button, Application, Document or ObjectStyle).
pinPosition bool r/w If true, pins the position of the anchored object within the text frame top and bottom.
properties Object r/w A property that allows setting of several properties at the same time.
spineRelative bool r/w If true, the position of the anchored object is relative to the binding spine of the page or spread.
verticalAlignment VerticalAlignment
:
TOP_ALIGN
BOTTOM_ALIGN
CENTER_ALIGN
r/w 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
:
COLUMN_EDGE
TEXT_FRAME
PAGE_MARGINS
PAGE_EDGE
LINE_BASELINE
LINE_XHEIGHT
LINE_ASCENT
CAPHEIGHT
TOP_OF_LEADING
r/w The vertical reference point on the page. Valid when anchored position is custom.

Methods

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

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of:

Application.anchoredObjectSettings
Button.anchoredObjectSettings
Document.anchoredObjectSettings
FormField.anchoredObjectSettings
GraphicLine.anchoredObjectSettings
Group.anchoredObjectSettings
ObjectStyle.anchoredObjectSettings
Oval.anchoredObjectSettings
PageItem.anchoredObjectSettings
Polygon.anchoredObjectSettings
Rectangle.anchoredObjectSettings
TextFrame.anchoredObjectSettings

Returned by:

Array of AnchoredObjectSetting AnchoredObjectSetting .getElements (

)

Leave a Comment

Previous post:

Next post: