FindObjectPreference

Find object preferences.

Methods:

actualText, addEventListener, altText, getElements, removeEventListener, toSource, toSpecifier

Objects:

AnchorPoint, AnchorPosition, AnchoredRelativeTo, ArrowHead, ArrowHeadAlignmentEnum, AutoSizingReferenceEnum, AutoSizingTypeEnum, BaselineFrameGridRelativeOption, Boolean, ContourOptionsTypes, CornerOptions, EmptyFrameFittingOptions, EndCap, EndJoin, EventListeners, Events, FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeTransparencySetting, FirstBaseline, GIFOptionsPalette, ImageAlignmentType, ImageFormat, ImagePageBreakType, ImageResolution, JPEGOptionsFormat, JPEGOptionsQuality, NothingEnum, Object, Preferences, PreserveAppearanceFromLayoutEnum, SourceType, StoryDirectionOptions, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, Swatch, TagType, TextWrapModes, TextWrapSideOptions, UIColors, VerticalJustification, VerticallyRelativeTo

Preferences:

Preferences

Hierarchy:

Superclass: Preference

Class: FindObjectPreference

Property Listing

Property

Type

Access

Description

actualMetadataProperty

OrderedarraycontainingnamespacePrefix:String

PropertyPath:String

NothingEnum.NOTHING

read/write

The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String or NothingEnum enumerator.

actualTextSourceType

SourceType

SourceType.SOURCE_CUSTOM

SourceType.SOURCE_XML_STRUCTURE

SourceType.SOURCE_XMP_DESCRIPTION

SourceType.SOURCE_XMP_HEADLINE

SourceType.SOURCE_XMP_OTHER

SourceType.SOURCE_XMP_TITLE

NothingEnum.NOTHING

read/write

The source type of actual text. Can return: SourceType enumerator or NothingEnum enumerator.

altMetadataProperty

OrderedarraycontainingnamespacePrefix:String

PropertyPath:String

NothingEnum.NOTHING

read/write

The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String or NothingEnum enumerator.

altTextSourceType

SourceType

SourceType.SOURCE_CUSTOM

SourceType.SOURCE_XML_STRUCTURE

SourceType.SOURCE_XMP_DESCRIPTION

SourceType.SOURCE_XMP_HEADLINE

SourceType.SOURCE_XMP_OTHER

SourceType.SOURCE_XMP_TITLE

NothingEnum.NOTHING

read/write

The source type of alternate text. Can return: SourceType enumerator or NothingEnum enumerator.

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

NothingEnum.NOTHING

read/write

The point in the anchored object to position. Can return: AnchorPoint enumerator or NothingEnum enumerator.

anchorSpaceAbove

Unit

NothingEnum.NOTHING

read/write

The space above an above-line anchored object. Can return: Unit or NothingEnum enumerator.

anchorXoffset

Unit

NothingEnum.NOTHING

read/write

The horizontal (x) offset of the anchored object. Can return: Unit or NothingEnum enumerator.

anchorYoffset

Unit

NothingEnum.NOTHING

read/write

The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning. Can return: Unit or NothingEnum enumerator.

anchoredPosition

AnchorPosition

AnchorPosition.ABOVE_LINE

AnchorPosition.ANCHORED

AnchorPosition.INLINE_POSITION

NothingEnum.NOTHING

read/write

The position of the anchored object relative to the anchor. Can return: AnchorPosition enumerator or NothingEnum enumerator.

appliedObjectStyles

String

NothingEnumCanalsoaccept:ObjectStyle

read/write

The applied object style(s). Can return: String or NothingEnum enumerator. Can also accept: ObjectStyle.

applyTagType

TagType

TagType.TAG_ARTIFACT

TagType.TAG_BASED_ON_OBJECT

TagType.TAG_FROM_STRUCTURE

NothingEnum.NOTHING

read/write

The tag type of page item. Can return: TagType enumerator or NothingEnum enumerator.

applyToMasterPageOnly

Boolean

NothingEnum.NOTHING

read/write

If true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to. Can return: Boolean or NothingEnum enumerator.

arrowHeadAlignment

ArrowHeadAlignmentEnum

ArrowHeadAlignmentEnum.INSIDE_PATH

ArrowHeadAlignmentEnum.OUTSIDE_PATH

NothingEnum.NOTHING

read/write

The arrowhead alignment applied to the FindObjectPreference. Can return: ArrowHeadAlignmentEnum enumerator or NothingEnum enumerator.

autoSizingReferencePoint

AutoSizingReferenceEnum

AutoSizingReferenceEnum.BOTTOM_CENTER_POINT

AutoSizingReferenceEnum.BOTTOM_LEFT_POINT

AutoSizingReferenceEnum.BOTTOM_RIGHT_POINT

AutoSizingReferenceEnum.CENTER_POINT

AutoSizingReferenceEnum.LEFT_CENTER_POINT

AutoSizingReferenceEnum.RIGHT_CENTER_POINT

AutoSizingReferenceEnum.TOP_CENTER_POINT

AutoSizingReferenceEnum.TOP_LEFT_POINT

AutoSizingReferenceEnum.TOP_RIGHT_POINT

NothingEnum.NOTHING

read/write

The reference point for auto sizing of text frame. Reference point is automatically adjusted to the suitable value depending on the auto-sizing type value. As an example, top left reference point becomes top center for height only dimension. Can return: AutoSizingReferenceEnum enumerator or NothingEnum enumerator.

autoSizingType

AutoSizingTypeEnum

AutoSizingTypeEnum.HEIGHT_AND_WIDTH

AutoSizingTypeEnum.HEIGHT_AND_WIDTH_PROPORTIONALLY

AutoSizingTypeEnum.HEIGHT_ONLY

AutoSizingTypeEnum.OFF

AutoSizingTypeEnum.WIDTH_ONLY

NothingEnum.NOTHING

read/write

Auto-sizing type of text frame. Based on type, reference value is automatically adjusted. For example, for height only type, top-left reference point becomes top-center. Recommended to change auto-sizing type, after setting other auto-sizing attributes. Can return: AutoSizingTypeEnum enumerator or NothingEnum enumerator.

baselineFrameGridColor

Array of 3 Reals (0 - 255)

NothingEnum.NOTHING

UIColors

read/write

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) or UIColors enumerator or NothingEnum enumerator.

baselineFrameGridIncrement

Unit(1-8640points)

NothingEnum.NOTHING

read/write

The distance between grid lines. Can return: Unit (1 - 8640 points) or NothingEnum enumerator.

baselineFrameGridRelativeOption

BaselineFrameGridRelativeOption

BaselineFrameGridRelativeOption.TOP_OF_FRAME

BaselineFrameGridRelativeOption.TOP_OF_INSET

BaselineFrameGridRelativeOption.TOP_OF_MARGIN

BaselineFrameGridRelativeOption.TOP_OF_PAGE

NothingEnum.NOTHING

read/write

The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid. Can return: BaselineFrameGridRelativeOption enumerator or NothingEnum enumerator.

bottomCrop

Unit

NothingEnum.NOTHING

read/write

The amount in measurement units to crop the bottom edge of a graphic. Can return: Unit or NothingEnum enumerator.

bottomLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

NothingEnum.NOTHING

read/write

The shape to apply to the bottom left corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.

bottomLeftCornerRadius

Unit

NothingEnum.NOTHING

read/write

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.

bottomRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

NothingEnum.NOTHING

read/write

The shape to apply to the bottom right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.

bottomRightCornerRadius

Unit

NothingEnum.NOTHING

read/write

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.

contentTransparencySettings

FindChangeContentTransparencySetting

NothingEnum.NOTHING

readonly

Transparency settings for the content of the FindObjectPreference. Can return: FindChangeContentTransparencySetting or NothingEnum enumerator.

contourType

ContourOptionsTypes

ContourOptionsTypes.ALPHA_CHANNEL

ContourOptionsTypes.BOUNDING_BOX

ContourOptionsTypes.DETECT_EDGES

ContourOptionsTypes.GRAPHIC_FRAME

ContourOptionsTypes.PHOTOSHOP_PATH

ContourOptionsTypes.SAME_AS_CLIPPING

NothingEnum.NOTHING

read/write

The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator.

customActualText

String

NothingEnum.NOTHING

read/write

The custom actual text entered by the user. Can return: String or NothingEnum enumerator.

customAltText

String

NothingEnum.NOTHING

read/write

The custom alternate text entered by the user. Can return: String or NothingEnum enumerator.

enableOverrides

Boolean

NothingEnum.NOTHING

read/write

If true, enable overrides to document footnote options. Can return: Boolean or NothingEnum enumerator.

endCap

EndCap

EndCap.BUTT_END_CAP

EndCap.PROJECTING_END_CAP

EndCap.ROUND_END_CAP

NothingEnum.NOTHING

read/write

The end shape of an open path. Can return: EndCap enumerator or NothingEnum enumerator.

endJoin

EndJoin

EndJoin.BEVEL_END_JOIN

EndJoin.MITER_END_JOIN

EndJoin.ROUND_END_JOIN

NothingEnum.NOTHING

read/write

The corner join applied to the FindObjectPreference. Can return: EndJoin enumerator or NothingEnum enumerator.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fillColor

Swatch

NothingEnumCanalsoaccept:String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the FindObjectPreference. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.

fillTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The percent of tint to use in the FindObjectPreference'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

FindChangeFillTransparencySetting

NothingEnum.NOTHING

readonly

Transparency settings for the fill applied to the FindObjectPreference. Can return: FindChangeFillTransparencySetting or NothingEnum enumerator.

firstBaselineOffset

FirstBaseline

FirstBaseline.ASCENT_OFFSET

FirstBaseline.CAP_HEIGHT

FirstBaseline.EMBOX_HEIGHT

FirstBaseline.FIXED_HEIGHT

FirstBaseline.LEADING_OFFSET

FirstBaseline.X_HEIGHT

NothingEnum.NOTHING

read/write

The distance between the baseline of the text and the top inset of the text frame or cell. Can return: FirstBaseline enumerator or NothingEnum enumerator.

fittingAlignment

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

NothingEnum.NOTHING

read/write

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

EmptyFrameFittingOptions

EmptyFrameFittingOptions.CONTENT_TO_FRAME

EmptyFrameFittingOptions.FILL_PROPORTIONALLY

EmptyFrameFittingOptions.NONE

EmptyFrameFittingOptions.PROPORTIONALLY

NothingEnum.NOTHING

read/write

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

Swatch

NothingEnum.NOTHING

read/write

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

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

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.

gifOptionsInterlaced

Boolean

NothingEnum.NOTHING

read/write

If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. Can return: Boolean or NothingEnum enumerator.

gifOptionsPalette

GIFOptionsPalette

GIFOptionsPalette.ADAPTIVE_PALETTE

GIFOptionsPalette.MACINTOSH_PALETTE

GIFOptionsPalette.WEB_PALETTE

GIFOptionsPalette.WINDOWS_PALETTE

NothingEnum.NOTHING

read/write

The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. . Can return: GIFOptionsPalette enumerator or NothingEnum enumerator.

gradientFillAngle

Real

NothingEnum.NOTHING

read/write

The angle of a linear gradient applied to the fill of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.

gradientStrokeAngle

Real

NothingEnum.NOTHING

read/write

The angle of a linear gradient applied to the stroke of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.

horizontalReferencePoint

AnchoredRelativeTo

AnchoredRelativeTo.ANCHOR_LOCATION

AnchoredRelativeTo.COLUMN_EDGE

AnchoredRelativeTo.PAGE_EDGE

AnchoredRelativeTo.PAGE_MARGINS

AnchoredRelativeTo.TEXT_FRAME

NothingEnum.NOTHING

read/write

The horizontal reference point on the page. Valid only when anchored position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum enumerator.

ignoreWrap

Boolean

NothingEnum.NOTHING

read/write

If true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: Boolean or NothingEnum enumerator.

imageAlignment

ImageAlignmentType

ImageAlignmentType.ALIGN_CENTER

ImageAlignmentType.ALIGN_LEFT

ImageAlignmentType.ALIGN_RIGHT

NothingEnum.NOTHING

read/write

Alignment applied to images. Can return: ImageAlignmentType enumerator or NothingEnum enumerator.

imageConversionType

ImageFormat

ImageFormat.GIF

ImageFormat.JPEG

ImageFormat.PNG

NothingEnum.NOTHING

read/write

Allows user to select the image format for conversion. Can return: ImageFormat enumerator or NothingEnum enumerator.

imageExportResolution

ImageResolution

ImageResolution.PPI_150

ImageResolution.PPI_300

ImageResolution.PPI_72

ImageResolution.PPI_96

NothingEnum.NOTHING

read/write

The export resolution. Can return: ImageResolution enumerator or NothingEnum enumerator.

imagePageBreak

ImagePageBreakType

ImagePageBreakType.PAGE_BREAK_AFTER

ImagePageBreakType.PAGE_BREAK_BEFORE

ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER

NothingEnum.NOTHING

read/write

Image page break settings to be used with objects. Can return: ImagePageBreakType enumerator or NothingEnum enumerator.

imageSpaceAfter

Real(0-8640)

NothingEnum.NOTHING

read/write

Space After applied to images. Can return: Real (0 - 8640) or NothingEnum enumerator.

imageSpaceBefore

Real(0-8640)

NothingEnum.NOTHING

read/write

Space Before applied to images. Can return: Real (0 - 8640) or NothingEnum enumerator.

includeInsideEdges

Boolean

NothingEnum.NOTHING

read/write

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

Array of 4 Units (0 - 8640 points)

Unit(0-8640points)

NothingEnum.NOTHING

read/write

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

Boolean

NothingEnum.NOTHING

read/write

If true, inverts the text wrap. Can return: Boolean or NothingEnum enumerator.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

jpegOptionsFormat

JPEGOptionsFormat

JPEGOptionsFormat.BASELINE_ENCODING

JPEGOptionsFormat.PROGRESSIVE_ENCODING

NothingEnum.NOTHING

read/write

The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. Can return: JPEGOptionsFormat enumerator or NothingEnum enumerator.

jpegOptionsQuality

JPEGOptionsQuality

JPEGOptionsQuality.HIGH

JPEGOptionsQuality.LOW

JPEGOptionsQuality.MAXIMUM

JPEGOptionsQuality.MEDIUM

NothingEnum.NOTHING

read/write

The quality of converted JPEG images. Note: Not valid when image conversion is GIF. . Can return: JPEGOptionsQuality enumerator or NothingEnum enumerator.

leftArrowHeadScale

Real (range 1 - 1000)

NothingEnum.NOTHING

read/write

The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.

leftCrop

Unit

NothingEnum.NOTHING

read/write

The amount in measurement units to crop the left edge of a graphic. Can return: Unit or NothingEnum enumerator.

leftLineEnd

ArrowHead

ArrowHead.BARBED_ARROW_HEAD

ArrowHead.BAR_ARROW_HEAD

ArrowHead.CIRCLE_ARROW_HEAD

ArrowHead.CIRCLE_SOLID_ARROW_HEAD

ArrowHead.CURVED_ARROW_HEAD

ArrowHead.NONE

ArrowHead.SIMPLE_ARROW_HEAD

ArrowHead.SIMPLE_WIDE_ARROW_HEAD

ArrowHead.SQUARE_ARROW_HEAD

ArrowHead.SQUARE_SOLID_ARROW_HEAD

ArrowHead.TRIANGLE_ARROW_HEAD

ArrowHead.TRIANGLE_WIDE_ARROW_HEAD

NothingEnum.NOTHING

read/write

The arrowhead applied to the start of the path. . Can return: ArrowHead enumerator or NothingEnum enumerator.

lockPosition

Boolean

NothingEnum.NOTHING

read/write

If true, prevents manual positioning of the anchored object. Can return: Boolean or NothingEnum enumerator.

minimumFirstBaselineOffset

Unit(0-8640points)

NothingEnum.NOTHING

read/write

The minimum distance between the baseline of the text and the top inset of the text frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

minimumHeightForAutoSizing

Unit

NothingEnum.NOTHING

read/write

The minimum height for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator.

minimumSpacingOption

Unit(0-8640points)

NothingEnum.NOTHING

read/write

Minimum Spacing Before First Footnote. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

minimumWidthForAutoSizing

Unit

NothingEnum.NOTHING

read/write

The minimum width for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator.

miterLimit

Real(1-500)

NothingEnum.NOTHING

read/write

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: Real (1 - 500) or NothingEnum enumerator.

nonprinting

Boolean

NothingEnum.NOTHING

read/write

If true, the FindObjectPreference does not print. Can return: Boolean or NothingEnum enumerator.

opticalMarginAlignment

Boolean

NothingEnum.NOTHING

read/write

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

Unit(01-1296points)

NothingEnum.NOTHING

read/write

The point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296). Can return: Unit (0.1 - 1296 points) or NothingEnum enumerator.

overprintFill

Boolean

NothingEnum.NOTHING

read/write

If true, the FindObjectPreference's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.

overprintGap

Boolean

NothingEnum.NOTHING

read/write

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

Boolean

NothingEnum.NOTHING

read/write

If true, the FindObjectPreference's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.

parent

Application

readonly

The parent of the FindObjectPreference (a Application).

pinPosition

Boolean

NothingEnum.NOTHING

read/write

If true, pins the position of the anchored object within the text frame top and bottom. Can return: Boolean or NothingEnum enumerator.

positionReferencePoint

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

NothingEnum.NOTHING

read/write

The point in the referenced object relative to which to position the anchored object. Notes: Valid only when anchored position is custom. Can return: AnchorPoint enumerator or NothingEnum enumerator.

preferences

Preferences Preference

readonly

A collection of preferences objects.

preserveAppearanceFromLayout

PreserveAppearanceFromLayoutEnum

PreserveAppearanceFromLayoutEnum.PRESERVE_APPEARANCE_DEFAULT

PreserveAppearanceFromLayoutEnum.PRESERVE_APPEARANCE_RASTERIZE_CONTAINER

PreserveAppearanceFromLayoutEnum.PRESERVE_APPEARANCE_RASTERIZE_CONTENT

PreserveAppearanceFromLayoutEnum.PRESERVE_APPEARANCE_USE_EXISTING_IMAGE

NothingEnum.NOTHING

read/write

Preserve Appearance from Layout. Can return: PreserveAppearanceFromLayoutEnum enumerator or NothingEnum enumerator.

properties

Object

read/write

A property that allows setting of several properties at the same time.

rightArrowHeadScale

Real (range 1 - 1000)

NothingEnum.NOTHING

read/write

The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.

rightCrop

Unit

NothingEnum.NOTHING

read/write

The amount in measurement units to crop the right edge of a graphic. Can return: Unit or NothingEnum enumerator.

rightLineEnd

ArrowHead

ArrowHead.BARBED_ARROW_HEAD

ArrowHead.BAR_ARROW_HEAD

ArrowHead.CIRCLE_ARROW_HEAD

ArrowHead.CIRCLE_SOLID_ARROW_HEAD

ArrowHead.CURVED_ARROW_HEAD

ArrowHead.NONE

ArrowHead.SIMPLE_ARROW_HEAD

ArrowHead.SIMPLE_WIDE_ARROW_HEAD

ArrowHead.SQUARE_ARROW_HEAD

ArrowHead.SQUARE_SOLID_ARROW_HEAD

ArrowHead.TRIANGLE_ARROW_HEAD

ArrowHead.TRIANGLE_WIDE_ARROW_HEAD

NothingEnum.NOTHING

read/write

The arrowhead applied to the end of the path. Can return: ArrowHead enumerator or NothingEnum enumerator.

spaceBetweenFootnotes

Unit(0-8640points)

NothingEnum.NOTHING

read/write

Space between footnotes. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

spanFootnotesAcross

Boolean

NothingEnum.NOTHING

read/write

If true, enable straddling footnotes. Can return: Boolean or NothingEnum enumerator.

spineRelative

Boolean

NothingEnum.NOTHING

read/write

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

Unit(0-8640points)

NothingEnum.NOTHING

read/write

The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

storyDirection

StoryDirectionOptions

StoryDirectionOptions.LEFT_TO_RIGHT_DIRECTION

StoryDirectionOptions.RIGHT_TO_LEFT_DIRECTION

StoryDirectionOptions.UNKNOWN_DIRECTION

NothingEnum.NOTHING

read/write

The direction of the story. Can return: StoryDirectionOptions enumerator or NothingEnum enumerator.

strokeAlignment

StrokeAlignment

StrokeAlignment.CENTER_ALIGNMENT

StrokeAlignment.INSIDE_ALIGNMENT

StrokeAlignment.OUTSIDE_ALIGNMENT

NothingEnum.NOTHING

read/write

The stroke alignment applied to the FindObjectPreference. Can return: StrokeAlignment enumerator or NothingEnum enumerator.

strokeColor

Swatch

NothingEnumCanalsoaccept:String

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FindObjectPreference. Can return: Swatch or NothingEnum enumerator. Can also accept: String.

strokeCornerAdjustment

StrokeCornerAdjustment

StrokeCornerAdjustment.DASHES

StrokeCornerAdjustment.DASHES_AND_GAPS

StrokeCornerAdjustment.GAPS

StrokeCornerAdjustment.NONE

NothingEnum.NOTHING

read/write

The corner adjustment applied to the FindObjectPreference. Can return: StrokeCornerAdjustment enumerator or NothingEnum enumerator.

strokeDashAndGap

Array of Units

NothingEnum.NOTHING

read/write

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

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

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

FindChangeStrokeTransparencySetting

NothingEnum.NOTHING

readonly

Transparency settings for the stroke. Can return: FindChangeStrokeTransparencySetting or NothingEnum enumerator.

strokeType

StrokeStyle

NothingEnumCanalsoaccept:String

read/write

The name of the stroke style to apply. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.

strokeWeight

Unit

NothingEnum.NOTHING

read/write

The weight (in points) to apply to the FindObjectPreference's stroke. Can return: Unit or NothingEnum enumerator.

textColumnCount

LongInteger(1-40)

NothingEnum.NOTHING

read/write

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.

textColumnFixedWidth

Unit(0-8640points)

NothingEnum.NOTHING

read/write

The column width of the columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

textColumnGutter

Unit(0-8640points)

NothingEnum.NOTHING

read/write

The space between columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.

textWrapMode

TextWrapModes

TextWrapModes.BOUNDING_BOX_TEXT_WRAP

TextWrapModes.CONTOUR

TextWrapModes.JUMP_OBJECT_TEXT_WRAP

TextWrapModes.NEXT_COLUMN_TEXT_WRAP

TextWrapModes.NONE

NothingEnum.NOTHING

read/write

The text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum enumerator.

textWrapOffset

Orderedarraycontainingtop:Unit

Bottom:Unit

Left:Unit

Right:Unit

NothingEnum.NOTHING

read/write

The minimum space between text and the edges of the wrapped object. Specify four values in the format [top, left, bottom, right]. . Can return: Ordered array containing top:Unit, left:Unit, bottom:Unit, right:Unit or NothingEnum enumerator.

textWrapSide

TextWrapSideOptions

TextWrapSideOptions.BOTH_SIDES

TextWrapSideOptions.LARGEST_AREA

TextWrapSideOptions.LEFT_SIDE

TextWrapSideOptions.RIGHT_SIDE

TextWrapSideOptions.SIDE_AWAY_FROM_SPINE

TextWrapSideOptions.SIDE_TOWARDS_SPINE

NothingEnum.NOTHING

read/write

Text wrap side options. Can return: TextWrapSideOptions enumerator or NothingEnum enumerator.

topCrop

Unit

NothingEnum.NOTHING

read/write

The amount in measurement units to crop the top edge of a graphic. Can return: Unit or NothingEnum enumerator.

topLeftCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

NothingEnum.NOTHING

read/write

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. Can return: CornerOptions enumerator or NothingEnum enumerator.

topLeftCornerRadius

Unit

NothingEnum.NOTHING

read/write

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes. Can return: Unit or NothingEnum enumerator.

topRightCornerOption

CornerOptions

CornerOptions.BEVEL_CORNER

CornerOptions.FANCY_CORNER

CornerOptions.INSET_CORNER

CornerOptions.INVERSE_ROUNDED_CORNER

CornerOptions.NONE

CornerOptions.ROUNDED_CORNER

NothingEnum.NOTHING

read/write

The shape to apply to the top right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.

topRightCornerRadius

Unit

NothingEnum.NOTHING

read/write

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.

transparencySettings

FindChangeTransparencySetting

NothingEnum.NOTHING

readonly

Transparency settings. Can return: FindChangeTransparencySetting or NothingEnum enumerator.

useCustomBaselineFrameGrid

Boolean

NothingEnum.NOTHING

read/write

If true, uses a custom baseline frame grid. Can return: Boolean or NothingEnum enumerator.

useFixedColumnWidth

Boolean

NothingEnum.NOTHING

read/write

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.

useImagePageBreak

Boolean

NothingEnum.NOTHING

read/write

If true, image page break settings will be used in objects. Can return: Boolean or NothingEnum enumerator.

useMinimumHeightForAutoSizing

Boolean

NothingEnum.NOTHING

read/write

If true, minimum height value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator.

useMinimumWidthForAutoSizing

Boolean

NothingEnum.NOTHING

read/write

If true, minimum width value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator.

useNoLineBreaksForAutoSizing

Boolean

NothingEnum.NOTHING

read/write

If true, line-breaks are not introduced after auto sizing. . Can return: Boolean or NothingEnum enumerator.

userModifiedWrap

Boolean

NothingEnum.NOTHING

readonly

If true, the text wrap path has been explicitly modified by the user. Can return: Boolean or NothingEnum enumerator.

verticalJustification

VerticalJustification

VerticalJustification.BOTTOM_ALIGN

VerticalJustification.CENTER_ALIGN

VerticalJustification.JUSTIFY_ALIGN

VerticalJustification.TOP_ALIGN

NothingEnum.NOTHING

read/write

The vertical alignment of the text content. . Can return: VerticalJustification enumerator or NothingEnum enumerator.

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

NothingEnum.NOTHING

read/write

The vertical reference point on the page. Valid when anchored position is custom. Can return: VerticallyRelativeTo enumerator or NothingEnum enumerator.

verticalThreshold

Unit(0-8640points)

NothingEnum.NOTHING

read/write

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.

Method Listing

String actualText ()

Provides the actual text for the object

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)

String altText ()

Provides the alternate text for the object

FindObjectPreference getElements ()

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

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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.findObjectPreferences

Event.parent

EventListener.parent

FindChangeContentTransparencySetting.parent

FindChangeFillTransparencySetting.parent

FindChangeStrokeTransparencySetting.parent

FindChangeTransparencySetting.parent

MutationEvent.parent

Preference.parent

Return

FindObjectPreference.getElements()