Class
Find object preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
FindObjectPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchorPoint | AnchorPointNothingEnum | r/w | The point in the anchored object to position. Can return: AnchorPoint enumerator or NothingEnum enumerator. |
| anchorSpaceAbove | NothingEnum Unit |
r/w | The space above an above-line anchored object. Can return: Unit or NothingEnum enumerator. |
| anchorXoffset | NothingEnum Unit |
r/w | The horizontal (x) offset of the anchored object. Can return: Unit or NothingEnum enumerator. |
| anchorYoffset | NothingEnum Unit |
r/w | 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 NothingEnum |
r/w | The position of the anchored object relative to the anchor. Can return: AnchorPosition enumerator or NothingEnum enumerator. |
| appliedObjectStyles | NothingEnum ObjectStyle String |
r/w | The applied object style(s). Can return: String or NothingEnum enumerator. Can also accept: ObjectStyle. |
| applyToMasterPageOnly | Boolean NothingEnum |
r/w | 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. |
| baselineFrameGridColor | 3 Reals (0 - 255) NothingEnum UIColors |
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) or UIColors enumerator or NothingEnum enumerator. |
| baselineFrameGridIncrement | NothingEnum Unit (1 - 8640 points) |
r/w | The distance between grid lines. Can return: Unit (1 - 8640 points) or NothingEnum enumerator. |
| baselineFrameGridRelativeOption | BaselineFrameGridRelativeOption NothingEnum |
r/w | 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 | NothingEnum Unit |
r/w | The amount in measurement units to crop the bottom edge of a graphic. Can return: Unit or NothingEnum enumerator. |
| bottomLeftCornerOption | CornerOptions NothingEnum |
r/w | The shape to apply to the bottom left corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. |
| bottomLeftCornerRadius | NothingEnum Unit |
r/w | 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 NothingEnum |
r/w | The shape to apply to the bottom right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. |
| bottomRightCornerRadius | NothingEnum Unit |
r/w | 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 |
readonly | Transparency settings for the content of the FindObjectPreference. Can return: FindChangeContentTransparencySetting or NothingEnum enumerator. |
| contourType | ContourOptionsTypes NothingEnum |
r/w | The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator. |
| endCap | EndCap NothingEnum |
r/w | The end shape of an open path. Can return: EndCap enumerator or NothingEnum enumerator. |
| endJoin | EndJoin NothingEnum |
r/w | The corner join applied to the FindObjectPreference. Can return: EndJoin enumerator or NothingEnum enumerator. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| fillColor | NothingEnum String Swatch |
r/w | 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 | NothingEnum Real |
r/w | 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 |
readonly | Transparency settings for the fill applied to the FindObjectPreference. Can return: FindChangeFillTransparencySetting or NothingEnum enumerator. |
| firstBaselineOffset | FirstBaseline NothingEnum |
r/w | 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 NothingEnum |
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 | EmptyFrameFittingOptions NothingEnum |
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 | NothingEnum Swatch |
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 | NothingEnum Real |
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 | NothingEnum Real |
r/w | The angle of a linear gradient applied to the fill of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientStrokeAngle | NothingEnum Real |
r/w | 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 NothingEnum |
r/w | The horizontal reference point on the page. Valid only when anchored position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum enumerator. |
| ignoreWrap | Boolean NothingEnum |
r/w | If true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: Boolean or NothingEnum enumerator. |
| includeInsideEdges | Boolean NothingEnum |
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 | Array of 4 Units (0 - 8640 points) NothingEnum Unit (0 - 8640 points) |
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 | Boolean NothingEnum |
r/w | If true, inverts the text wrap. Can return: Boolean or NothingEnum enumerator. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| leftCrop | NothingEnum Unit |
r/w | The amount in measurement units to crop the left edge of a graphic. Can return: Unit or NothingEnum enumerator. |
| leftLineEnd | ArrowHead NothingEnum |
r/w | The arrowhead applied to the start of the path. . Can return: ArrowHead enumerator or NothingEnum enumerator. |
| lockPosition | Boolean NothingEnum |
r/w | If true, prevents manual positioning of the anchored object. Can return: Boolean or NothingEnum enumerator. |
| minimumFirstBaselineOffset | NothingEnum Unit (0 - 8640 points) |
r/w | 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. |
| miterLimit | NothingEnum Real (1 - 500) |
r/w | 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. (default: 4) |
| nonprinting | Boolean NothingEnum |
r/w | If true, the FindObjectPreference does not print. Can return: Boolean or NothingEnum enumerator. |
| opticalMarginAlignment | Boolean NothingEnum |
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 | Unit (0 | r/w | 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 |
r/w | 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 |
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 | Boolean NothingEnum |
r/w | 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 |
r/w | If true, pins the position of the anchored object within the text frame top and bottom. Can return: Boolean or NothingEnum enumerator. |
| positionReferencePoint | AnchorPoint NothingEnum |
r/w | 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 | readonly | A collection of preferences objects. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightCrop | NothingEnum Unit |
r/w | The amount in measurement units to crop the right edge of a graphic. Can return: Unit or NothingEnum enumerator. |
| rightLineEnd | ArrowHead NothingEnum |
r/w | The arrowhead applied to the end of the path. Can return: ArrowHead enumerator or NothingEnum enumerator. |
| spineRelative | Boolean NothingEnum |
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 | NothingEnum Unit (0 - 8640 points) |
r/w | The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. |
| storyDirection | NothingEnum StoryDirectionOptions |
r/w | The direction of the story. Can return: StoryDirectionOptions enumerator or NothingEnum enumerator. |
| strokeAlignment | NothingEnum StrokeAlignment |
r/w | The stroke alignment applied to the FindObjectPreference. Can return: StrokeAlignment enumerator or NothingEnum enumerator. |
| strokeColor | NothingEnum String Swatch |
r/w | 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 | NothingEnum StrokeCornerAdjustment |
r/w | The corner adjustment applied to the FindObjectPreference. Can return: StrokeCornerAdjustment enumerator or NothingEnum enumerator. |
| strokeDashAndGap | NothingEnum Units |
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 | NothingEnum Real |
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 | FindChangeStrokeTransparencySetting NothingEnum |
readonly | Transparency settings for the stroke. Can return: FindChangeStrokeTransparencySetting or NothingEnum enumerator. |
| strokeType | NothingEnum String StrokeStyle |
r/w | The name of the stroke style to apply. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. |
| strokeWeight | NothingEnum Unit |
r/w | The weight (in points) to apply to the FindObjectPreference's stroke. Can return: Unit or NothingEnum enumerator. |
| textColumnCount | Long Integer (1 - 40) NothingEnum |
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. |
| textColumnFixedWidth | NothingEnum Unit (0 - 8640 points) |
r/w | The column width of the columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. |
| textColumnGutter | NothingEnum Unit (0 - 8640 points) |
r/w | The space between columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. |
| textWrapMode | NothingEnum TextWrapModes |
r/w | The text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum enumerator. |
| textWrapOffset | bottom:Unit left:Unit NothingEnum Ordered array containing top:Unit right:Unit |
r/w | 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 | NothingEnum TextWrapSideOptions |
r/w | Text wrap side options. Can return: TextWrapSideOptions enumerator or NothingEnum enumerator. |
| topCrop | NothingEnum Unit |
r/w | The amount in measurement units to crop the top edge of a graphic. Can return: Unit or NothingEnum enumerator. |
| topLeftCornerOption | CornerOptions NothingEnum |
r/w | 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 | NothingEnum Unit |
r/w | 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 NothingEnum |
r/w | The shape to apply to the top right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. |
| topRightCornerRadius | NothingEnum Unit |
r/w | 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 |
readonly | Transparency settings. Can return: FindChangeTransparencySetting or NothingEnum enumerator. |
| useCustomBaselineFrameGrid | Boolean NothingEnum |
r/w | If true, uses a custom baseline frame grid. Can return: Boolean or NothingEnum enumerator. |
| useFixedColumnWidth | Boolean NothingEnum |
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. |
| userModifiedWrap | Boolean NothingEnum |
readonly | If true, the text wrap path has been explicitly modified by the user. Can return: Boolean or NothingEnum enumerator. |
| verticalJustification | NothingEnum VerticalJustification |
r/w | The vertical alignment of the text content. . Can return: VerticalJustification enumerator or NothingEnum enumerator. |
| verticalReferencePoint | NothingEnum VerticallyRelativeTo |
r/w | The vertical reference point on the page. Valid when anchored position is custom. Can return: VerticallyRelativeTo enumerator or NothingEnum enumerator. |
| verticalThreshold | NothingEnum Unit (0 - 8640 points) |
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. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | 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.
Element of
Application.findObjectPreferences
FindChangeContentTransparencySetting.parent
FindChangeFillTransparencySetting.parent
Return
Array of FindObjectPreference FindObjectPreference.getElements ()
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |