ChangeObjectPreference

Change object preferences.

Properties

Property Type Access Description
anchoredPosition any r/w The position of the anchored object relative to the anchor. Can return: AnchorPosition enumerator or NothingEnum enumerator.
anchorPoint any r/w The point in the anchored object to position. Can return: AnchorPoint enumerator or NothingEnum enumerator.
anchorSpaceAbove any r/w The space above an above-line anchored object. Can return: Unit or NothingEnum enumerator.
anchorXoffset any r/w The horizontal (x) offset of the anchored object. Can return: Unit or NothingEnum enumerator.
anchorYoffset any r/w The vertical (y) offset of the anchored object. Can return: Unit or NothingEnum enumerator.
appliedObjectStyles any r/w The applied object style(s). Can return: String or NothingEnum enumerator. Can also accept: ObjectStyle.
baselineFrameGridColor any r/w The grid line color, 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), UIColors enumerator or NothingEnum enumerator.
baselineFrameGridIncrement any r/w The distance between grid lines. Can return: Unit (1 - 8640 points) or NothingEnum enumerator (1 - 8640).
baselineFrameGridRelativeOption any r/w The object from which to offset the custom baseline grid. Can return: BaselineFrameGridRelativeOption enumerator or NothingEnum enumerator.
bottomCrop any r/w The amount in measurement units to crop the bottom edge of a graphic. Can return: Unit or NothingEnum enumerator.
contentTransparencySettings any readonly Transparency settings for the content of the ChangeObjectPreference. Can return: ContentTransparencySetting or NothingEnum enumerator.
contourType any r/w The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator.
cornerOption any r/w The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight. Can return: CornerOptions enumerator or NothingEnum enumerator.
cornerRadius any r/w The radius in measurement units of the corner effect. Can return: Unit or NothingEnum enumerator.
endCap any r/w The end shape of an open path. Can return: EndCap enumerator or NothingEnum enumerator.
endJoin any r/w The corner join applied to the ChangeObjectPreference. Can return: EndJoin enumerator or NothingEnum enumerator.
fillColor any r/w The swatch (color, gradient, tint, or mixed ink) applied to the to fill the ChangeObjectPreference. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTint any r/w The percent of tint to use in the ChangeObjectPreference's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: Real or NothingEnum enumerator.
fillTransparencySettings any readonly Transparency settings for the fill applied to the ChangeObjectPreference. Can return: FillTransparencySetting or NothingEnum enumerator.
firstBaselineOffset any r/w The distance between the baseline of the text and the top inset of the ChangeObjectPreference. Can return: FirstBaseline enumerator or NothingEnum enumerator.
fittingAlignment any r/w The point with which to align the image empty when fitting in a frame. For information, see frame fitting options. Can return: AnchorPoint enumerator or NothingEnum enumerator.
fittingOnEmptyFrame any r/w The frame fitting option to apply to placed or pasted content if the frame is empty. Can be applied to a frame, object style, or document or to the application. Can return: EmptyFrameFittingOptions enumerator or NothingEnum enumerator.
gapColor any r/w The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. Can return: Swatch or NothingEnum enumerator.
gapTint any r/w The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: Real or NothingEnum enumerator.
gradientFillAngle any r/w The angle of a linear gradient applied to the fill of the ChangeObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeAngle any r/w The angle of a linear gradient applied to the stroke of the ChangeObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
horizontalAlignment any 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. Can return: HorizontalAlignment enumerator or NothingEnum enumerator.
horizontalReferencePoint any r/w The horizontal reference point on the page. Valid only when anchored position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum enumerator.
ignoreWrap any r/w If true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: Boolean or NothingEnum enumerator.
includeInsideEdges any r/w If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges. . Can return: Boolean or NothingEnum enumerator.
insetSpacing any r/w The amount to offset text from the edges of the text frame, specified either as a single value applied uniformly to all sides of the text frame or as an array of 4 values in the format [top inset, left inset, bottom inset, right inset]. Can return: Unit (0 - 8640 points), Array of 4 Units (0 - 8640 points) or NothingEnum enumerator.
inverse any r/w If true, inverts the text wrap. Can return: Boolean or NothingEnum enumerator.
leftCrop any r/w The amount in measurement units to crop the left edge of a graphic. Can return: Unit or NothingEnum enumerator.
leftLineEnd any r/w The arrowhead applied to the start of the path. . Can return: ArrowHead enumerator or NothingEnum enumerator.
lockPosition any r/w If true, prevents manual positioning of the anchored object. Can return: Boolean or NothingEnum enumerator.
minimumFirstBaselineOffset any r/w The minimum distance between the baseline of the text and the top inset of the ChangeObjectPreference. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640).
miterLimit any r/w The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500). Can return: Real or NothingEnum enumerator.
nonprinting any r/w If true, the ChangeObjectPreference does not print. Can return: Boolean or NothingEnum enumerator.
opticalMarginAlignment any r/w If true, adjust the position of characters at the edges of the frame to provide a better appearance. Can return: Boolean or NothingEnum enumerator.
opticalMarginSize any r/w The point size used as a base for calculating optical margin alginment. (Range: 0.1 to 1296). Can return: Unit (0.1 - 1296 points) or NothingEnum enumerator (0.1 - 1296).
overprintFill any r/w If true, the ChangeObjectPreference's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.
overprintGap any r/w If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.
overprintStroke any r/w If true, the ChangeObjectPreference's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.
parent any readonly The parent of the ChangeObjectPreference (a Application).
pinPosition any r/w If true, pins the position of the anchored object within the text frame top and bottom. Can return: Boolean or NothingEnum enumerator.
properties Object r/w A property that allows setting of several properties at the same time.
rightCrop any r/w The amount in measurement units to crop the right edge of a graphic. Can return: Unit or NothingEnum enumerator.
rightLineEnd any r/w The arrowhead applied to the end of the path. Can return: ArrowHead enumerator or NothingEnum enumerator.
spineRelative any r/w If true, the position of the anchored object is relative to the binding spine of the page or spread. Can return: Boolean or NothingEnum enumerator.
startingOffsetForBaselineFrameGrid any r/w The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640).
strokeAlignment any r/w The stroke alignment applied to the ChangeObjectPreference. Can return: StrokeAlignment enumerator or NothingEnum enumerator.
strokeColor any r/w The swatch (color, gradient, tint, or mixed ink) applied to the to stroke of the ChangeObjectPreference. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeCornerAdjustment any r/w The corner adjustment applied to the ChangeObjectPreference. Can return: StrokeCornerAdjustment enumerator or NothingEnum enumerator.
strokeDashAndGap any r/w The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. Can return: Array of Units or NothingEnum enumerator.
strokeTint any r/w The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: Real or NothingEnum enumerator.
strokeTransparencySettings any readonly Transparency settings for the stroke. Can return: StrokeTransparencySetting or NothingEnum enumerator.
strokeType any r/w The name of the stroke style to apply. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
strokeWeight any r/w The weight (in points) to apply to the ChangeObjectPreference's stroke. Can return: Unit or NothingEnum enumerator.
textColumnCount any r/w The number of columns in the text frame. Note: Depending on the value of use fixed column width, the number of columns can change automatically when the text frame size changes. Can return: Long Integer (1 - 40) or NothingEnum enumerator (1 - 40).
textColumnFixedWidth any r/w The column width of the columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640).
textColumnGutter any r/w The space between columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640).
textWrapOffset any r/w The minimum space between text and the edges of the wrapped object. The format for defining text wrap offset values depends on the text wrap type. If text wrap type is jump object text wrap, specify 2 values in the format [top, bottom]. If text wrap type is next column text wrap or contour, specify a single value. For bounding box text wrap, specify 4 values in the format in the format [top, left, bottom, right]. . Can return: Unit, Array of Units or NothingEnum enumerator.
textWrapType any r/w The text wrap type. . Can return: TextWrapTypes enumerator or NothingEnum enumerator.
topCrop any r/w The amount in measurement units to crop the top edge of a graphic. Can return: Unit or NothingEnum enumerator.
transparencySettings any readonly Transparency settings. Can return: TransparencySetting or NothingEnum enumerator.
useCustomBaselineFrameGrid any r/w If true, uses a custom baseline frame grid. Can return: Boolean or NothingEnum enumerator.
useFixedColumnWidth any r/w If true, maintains column width when the text frame is resized. If false, causes columns to resize when the text frame is resized. Note: When true, resizing the frame can change the number of columns in the frame. Can return: Boolean or NothingEnum enumerator.
verticalAlignment any 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. Can return: VerticalAlignment enumerator or NothingEnum enumerator.
verticalJustification any r/w The vertical alignment of the text content. . Can return: VerticalJustification enumerator or NothingEnum enumerator.
verticalReferencePoint any r/w The vertical reference point on the page. Valid when anchored position is custom. Can return: VerticallyRelativeTo enumerator or NothingEnum enumerator.
verticalThreshold any r/w The maximum amount of vertical space between two paragraphs. Note: Valid only when vertical justification is justified; the specified amount is applied in addition to the space before or space after values defined for the paragraph. Can return: Unit (0 - 8640 points) or NothingEnum enumerator (0 - 8640).

Methods

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of:

Application.changeObjectPreferences

Returned by:

Array of ChangeObjectPreference ChangeObjectPreference.getElements ( )