Class

FindObjectPreference

 Find object preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
FindObjectPreference
Event | EventListener | FindChangeContentTransparencySetting | FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeTransparencySetting | MutationEvent | Preference

Properties

PropertyTypeAccessDescription
anchorPointAnchorPoint
NothingEnum
r/wThe point in the anchored object to position. Can return: AnchorPoint enumerator or NothingEnum enumerator.
anchorSpaceAboveNothingEnum
Unit
r/wThe space above an above-line anchored object. Can return: Unit or NothingEnum enumerator.
anchorXoffsetNothingEnum
Unit
r/wThe horizontal (x) offset of the anchored object. Can return: Unit or NothingEnum enumerator.
anchorYoffsetNothingEnum
Unit
r/wThe vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning. Can return: Unit or NothingEnum enumerator.
anchoredPositionAnchorPosition
NothingEnum
r/wThe position of the anchored object relative to the anchor. Can return: AnchorPosition enumerator or NothingEnum enumerator.
appliedObjectStylesNothingEnum
ObjectStyle
String
r/wThe applied object style(s). Can return: String or NothingEnum enumerator. Can also accept: ObjectStyle.
applyToMasterPageOnlyBoolean
NothingEnum
r/wIf 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.
autoSizingReferencePointAutoSizingReferenceEnum
NothingEnum
r/wThe 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.
autoSizingTypeAutoSizingTypeEnum
NothingEnum
r/wAuto-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.
baselineFrameGridColor3 Reals (0 - 255)
NothingEnum
UIColors
r/wThe 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.
baselineFrameGridIncrementNothingEnum
Unit (1 - 8640 points)
r/wThe distance between grid lines. Can return: Unit (1 - 8640 points) or NothingEnum enumerator.
baselineFrameGridRelativeOptionBaselineFrameGridRelativeOption
NothingEnum
r/wThe 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.
bottomCropNothingEnum
Unit
r/wThe amount in measurement units to crop the bottom edge of a graphic. Can return: Unit or NothingEnum enumerator.
bottomLeftCornerOptionCornerOptions
NothingEnum
r/wThe shape to apply to the bottom left corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.
bottomLeftCornerRadiusNothingEnum
Unit
r/wThe radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.
bottomRightCornerOptionCornerOptions
NothingEnum
r/wThe shape to apply to the bottom right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.
bottomRightCornerRadiusNothingEnum
Unit
r/wThe radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.
contentTransparencySettingsFindChangeContentTransparencySetting
NothingEnum
readonlyTransparency settings for the content of the FindObjectPreference. Can return: FindChangeContentTransparencySetting or NothingEnum enumerator.
contourTypeContourOptionsTypes
NothingEnum
r/wThe contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator.
endCapEndCap
NothingEnum
r/wThe end shape of an open path. Can return: EndCap enumerator or NothingEnum enumerator.
endJoinEndJoin
NothingEnum
r/wThe corner join applied to the FindObjectPreference. Can return: EndJoin enumerator or NothingEnum enumerator.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fillColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the FindObjectPreference. . Can return: Swatch or NothingEnum enumerator. Can also accept: String.
fillTintNothingEnum
Real
r/wThe 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.
fillTransparencySettingsFindChangeFillTransparencySetting
NothingEnum
readonlyTransparency settings for the fill applied to the FindObjectPreference. Can return: FindChangeFillTransparencySetting or NothingEnum enumerator.
firstBaselineOffsetFirstBaseline
NothingEnum
r/wThe distance between the baseline of the text and the top inset of the text frame or cell. Can return: FirstBaseline enumerator or NothingEnum enumerator.
fittingAlignmentAnchorPoint
NothingEnum
r/wThe 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.
fittingOnEmptyFrameEmptyFrameFittingOptions
NothingEnum
r/wThe 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.
gapColorNothingEnum
Swatch
r/wThe 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.
gapTintNothingEnum
Real
r/wThe 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.
gradientFillAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the fill of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the stroke of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
horizontalReferencePointAnchoredRelativeTo
NothingEnum
r/wThe horizontal reference point on the page. Valid only when anchored position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum enumerator.
ignoreWrapBoolean
NothingEnum
r/wIf true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: Boolean or NothingEnum enumerator.
includeInsideEdgesBoolean
NothingEnum
r/wIf 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.
insetSpacingArray of 4 Units (0 - 8640 points)
NothingEnum
Unit (0 - 8640 points)
r/wThe 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.
inverseBoolean
NothingEnum
r/wIf true, inverts the text wrap. Can return: Boolean or NothingEnum enumerator.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftCropNothingEnum
Unit
r/wThe amount in measurement units to crop the left edge of a graphic. Can return: Unit or NothingEnum enumerator.
leftLineEndArrowHead
NothingEnum
r/wThe arrowhead applied to the start of the path. . Can return: ArrowHead enumerator or NothingEnum enumerator.
lockPositionBoolean
NothingEnum
r/wIf true, prevents manual positioning of the anchored object. Can return: Boolean or NothingEnum enumerator.
minimumFirstBaselineOffsetNothingEnum
Unit (0 - 8640 points)
r/wThe 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.
minimumHeightForAutoSizingNothingEnum
Unit
r/wThe minimum height for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator.
minimumWidthForAutoSizingNothingEnum
Unit
r/wThe minimum width for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator.
miterLimitNothingEnum
Real (1 - 500)
r/wThe 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. (default: 4)
nonprintingBoolean
NothingEnum
r/wIf true, the FindObjectPreference does not print. Can return: Boolean or NothingEnum enumerator.
opticalMarginAlignmentBoolean
NothingEnum
r/wIf true, adjust the position of characters at the edges of the frame to provide a better appearance. Can return: Boolean or NothingEnum enumerator.
opticalMarginSizeUnit (0 r/wThe 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.
overprintFillBoolean
NothingEnum
r/wIf 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.
overprintGapBoolean
NothingEnum
r/wIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. Can return: Boolean or NothingEnum enumerator.
overprintStrokeBoolean
NothingEnum
r/wIf 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.
parentApplication readonlyThe parent of the FindObjectPreference (a Application).
pinPositionBoolean
NothingEnum
r/wIf true, pins the position of the anchored object within the text frame top and bottom. Can return: Boolean or NothingEnum enumerator.
positionReferencePointAnchorPoint
NothingEnum
r/wThe 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.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightCropNothingEnum
Unit
r/wThe amount in measurement units to crop the right edge of a graphic. Can return: Unit or NothingEnum enumerator.
rightLineEndArrowHead
NothingEnum
r/wThe arrowhead applied to the end of the path. Can return: ArrowHead enumerator or NothingEnum enumerator.
spineRelativeBoolean
NothingEnum
r/wIf true, the position of the anchored object is relative to the binding spine of the page or spread. Can return: Boolean or NothingEnum enumerator.
startingOffsetForBaselineFrameGridNothingEnum
Unit (0 - 8640 points)
r/wThe amount to offset the baseline grid. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.
storyDirectionNothingEnum
StoryDirectionOptions
r/wThe direction of the story. Can return: StoryDirectionOptions enumerator or NothingEnum enumerator.
strokeAlignmentNothingEnum
StrokeAlignment
r/wThe stroke alignment applied to the FindObjectPreference. Can return: StrokeAlignment enumerator or NothingEnum enumerator.
strokeColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FindObjectPreference. Can return: Swatch or NothingEnum enumerator. Can also accept: String.
strokeCornerAdjustmentNothingEnum
StrokeCornerAdjustment
r/wThe corner adjustment applied to the FindObjectPreference. Can return: StrokeCornerAdjustment enumerator or NothingEnum enumerator.
strokeDashAndGapNothingEnum
Units
r/wThe 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.
strokeTintNothingEnum
Real
r/wThe 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.
strokeTransparencySettingsFindChangeStrokeTransparencySetting
NothingEnum
readonlyTransparency settings for the stroke. Can return: FindChangeStrokeTransparencySetting or NothingEnum enumerator.
strokeTypeNothingEnum
String
StrokeStyle
r/wThe name of the stroke style to apply. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String.
strokeWeightNothingEnum
Unit
r/wThe weight (in points) to apply to the FindObjectPreference's stroke. Can return: Unit or NothingEnum enumerator.
textColumnCountLong Integer (1 - 40)
NothingEnum
r/wThe 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.
textColumnFixedWidthNothingEnum
Unit (0 - 8640 points)
r/wThe column width of the columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.
textColumnGutterNothingEnum
Unit (0 - 8640 points)
r/wThe space between columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator.
textWrapModeNothingEnum
TextWrapModes
r/wThe text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum enumerator.
textWrapOffsetbottom:Unit
left:Unit
NothingEnum
Ordered array containing top:Unit
right:Unit
r/wThe 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.
textWrapSideNothingEnum
TextWrapSideOptions
r/wText wrap side options. Can return: TextWrapSideOptions enumerator or NothingEnum enumerator.
topCropNothingEnum
Unit
r/wThe amount in measurement units to crop the top edge of a graphic. Can return: Unit or NothingEnum enumerator.
topLeftCornerOptionCornerOptions
NothingEnum
r/wThe 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.
topLeftCornerRadiusNothingEnum
Unit
r/wThe 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.
topRightCornerOptionCornerOptions
NothingEnum
r/wThe shape to apply to the top right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator.
topRightCornerRadiusNothingEnum
Unit
r/wThe radius in measurement units of the corner effect applied to the top right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator.
transparencySettingsFindChangeTransparencySetting
NothingEnum
readonlyTransparency settings. Can return: FindChangeTransparencySetting or NothingEnum enumerator.
useCustomBaselineFrameGridBoolean
NothingEnum
r/wIf true, uses a custom baseline frame grid. Can return: Boolean or NothingEnum enumerator.
useFixedColumnWidthBoolean
NothingEnum
r/wIf 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.
useMinimumHeightForAutoSizingBoolean
NothingEnum
r/wIf true, minimum height value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator.
useMinimumWidthForAutoSizingBoolean
NothingEnum
r/wIf true, minimum width value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator.
useNoLineBreaksForAutoSizingBoolean
NothingEnum
r/wIf true, line-breaks are not introduced after auto sizing. . Can return: Boolean or NothingEnum enumerator.
userModifiedWrapBoolean
NothingEnum
readonlyIf true, the text wrap path has been explicitly modified by the user. Can return: Boolean or NothingEnum enumerator.
verticalJustificationNothingEnum
VerticalJustification
r/wThe vertical alignment of the text content. . Can return: VerticalJustification enumerator or NothingEnum enumerator.
verticalReferencePointNothingEnum
VerticallyRelativeTo
r/wThe vertical reference point on the page. Valid when anchored position is custom. Can return: VerticallyRelativeTo enumerator or NothingEnum enumerator.
verticalThresholdNothingEnum
Unit (0 - 8640 points)
r/wThe 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.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.findObjectPreferences

FindChangeContentTransparencySetting.parent

FindChangeFillTransparencySetting.parent

FindChangeStrokeTransparencySetting.parent

FindChangeTransparencySetting.parent

Return

Array of FindObjectPreference FindObjectPreference.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index