Adobe InDesign CS3 (5.0) Object Model JS: FindObjectPreference

InDesign CS3

Class

FindObjectPreference

 Find object preferences.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application
FindObjectPreference
ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting

Properties

PropertyTypeAccessDescription
anchorPointAnchorPointNothingEnum 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.
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.
contentTransparencySettingsContentTransparencySetting
NothingEnum
readonlyTransparency settings for the content of the FindObjectPreference. Can return: ContentTransparencySetting or NothingEnum enumerator.
contourTypeContourOptionsTypes
NothingEnum
r/wThe contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator.
cornerOptionCornerOptions
NothingEnum
r/wThe 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.
cornerRadiusNothingEnum
Unit
r/wThe radius in measurement units of the corner effect. Can return: Unit 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.
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.
fillTransparencySettingsFillTransparencySetting
NothingEnum
readonlyTransparency settings for the fill applied to the FindObjectPreference. Can return: FillTransparencySetting 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.
horizontalAlignmentHorizontalAlignment
NothingEnum
r/wWhen 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.
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.
insetSpacing Array 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.
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.
miterLimitNothingEnum
Real
r/wThe 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.
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.
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.
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.
strokeTransparencySettingsNothingEnum
StrokeTransparencySetting
readonlyTransparency settings for the stroke. Can return: StrokeTransparencySetting 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.
textWrapOffset Array of Units
NothingEnum
Unit
r/wThe 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.
textWrapTypeNothingEnum
TextWrapTypes
r/wThe text wrap type. . Can return: TextWrapTypes 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.
transparencySettingsNothingEnum
TransparencySetting
readonlyTransparency settings. Can return: TransparencySetting 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.
verticalAlignmentNothingEnum
VerticalAlignment
r/wThe 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.
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

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.findObjectPreferences

Return

Array of FindObjectPreference FindObjectPreference.getElements ()

Jongware, 27-Jun-2010 v3.0.3dContents :: Index