Extends
Instance Properties
| Name | Description | Access |
|---|---|---|
| actualMetadataProperty | The metadata property to use as source of actual text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String or NothingEnum enumerator. | read-write |
| actualTextSourceType | The source type of actual text. Can return: SourceType enumerator or NothingEnum enumerator. | read-write |
| altMetadataProperty | The metadata property to use as source of alternate text. Can return: Ordered array containing namespacePrefix:String, propertyPath:String or NothingEnum enumerator. | read-write |
| altTextSourceType | The source type of alternate text. Can return: SourceType enumerator or NothingEnum enumerator. | read-write |
| anchorPoint | The point in the anchored object to position. Can return: AnchorPoint enumerator or NothingEnum enumerator. | read-write |
| anchorSpaceAbove | The space above an above-line anchored object. Can return: Unit or NothingEnum enumerator. | read-write |
| anchorXoffset | The horizontal (x) offset of the anchored object. Can return: Unit or NothingEnum enumerator. | read-write |
| anchorYoffset | The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning. Can return: Unit or NothingEnum enumerator. | read-write |
| anchoredPosition | The position of the anchored object relative to the anchor. Can return: AnchorPosition enumerator or NothingEnum enumerator. | read-write |
| appliedObjectStyles | The applied object style(s). Can return: String or NothingEnum enumerator. Can also accept: ObjectStyle. | read-write |
| applyTagType | The tag type of page item. Can return: TagType enumerator or NothingEnum enumerator. | read-write |
| applyToMasterPageOnly | 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. | read-write |
| arrowHeadAlignment | The arrowhead alignment applied to the FindObjectPreference. Can return: ArrowHeadAlignmentEnum enumerator or NothingEnum enumerator. | read-write |
| autoSizingReferencePoint | 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. | read-write |
| autoSizingType | 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. | read-write |
| baselineFrameGridColor | 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. | read-write |
| baselineFrameGridIncrement | The distance between grid lines. Can return: Unit (1 - 8640 points) or NothingEnum enumerator. | read-write |
| baselineFrameGridRelativeOption | 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. | read-write |
| bottomCrop | The amount in measurement units to crop the bottom edge of a graphic. Can return: Unit or NothingEnum enumerator. | read-write |
| bottomLeftCornerOption | The shape to apply to the bottom left corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. | read-write |
| bottomLeftCornerRadius | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes. Can return: Unit or NothingEnum enumerator. | read-write |
| bottomRightCornerOption | The shape to apply to the bottom right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. | read-write |
| bottomRightCornerRadius | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator. | read-write |
| contentTransparencySettings | Transparency settings for the content of the FindObjectPreference. Can return: FindChangeContentTransparencySetting or NothingEnum enumerator. | read-only |
| contourType | The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum enumerator. | read-write |
| customActualText | The custom actual text entered by the user. Can return: String or NothingEnum enumerator. | read-write |
| customAltText | The custom alternate text entered by the user. Can return: String or NothingEnum enumerator. | read-write |
| enableOverrides | If true, enable overrides to document footnote options. Can return: Boolean or NothingEnum enumerator. | read-write |
| endCap | The end shape of an open path. Can return: EndCap enumerator or NothingEnum enumerator. | read-write |
| endJoin | The corner join applied to the FindObjectPreference. Can return: EndJoin enumerator or NothingEnum enumerator. | read-write |
| eventListeners | EventListeners A collection of event listeners. | read-only |
| events | Events A collection of events. | read-only |
| fillColor | 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. | read-write |
| fillTint | 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. | read-write |
| fillTransparencySettings | Transparency settings for the fill applied to the FindObjectPreference. Can return: FindChangeFillTransparencySetting or NothingEnum enumerator. | read-only |
| firstBaselineOffset | 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. | read-write |
| fittingAlignment | 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. | read-write |
| fittingOnEmptyFrame | 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. | read-write |
| gapColor | 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. | read-write |
| gapTint | 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. | read-write |
| gifOptionsInterlaced | If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. Can return: Boolean or NothingEnum enumerator. | read-write |
| gifOptionsPalette | The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. . Can return: GIFOptionsPalette enumerator or NothingEnum enumerator. | read-write |
| gradientFillAngle | The angle of a linear gradient applied to the fill of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. | read-write |
| gradientStrokeAngle | The angle of a linear gradient applied to the stroke of the FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. | read-write |
| horizontalReferencePoint | The horizontal reference point on the page. Valid only when anchored position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum enumerator. | read-write |
| ignoreWrap | If true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: Boolean or NothingEnum enumerator. | read-write |
| imageAlignment | Alignment applied to images. Can return: ImageAlignmentType enumerator or NothingEnum enumerator. | read-write |
| imageConversionType | Allows user to select the image format for conversion. Can return: ImageFormat enumerator or NothingEnum enumerator. | read-write |
| imageExportResolution | The export resolution. Can return: ImageResolution enumerator or NothingEnum enumerator. | read-write |
| imagePageBreak | Image page break settings to be used with objects. Can return: ImagePageBreakType enumerator or NothingEnum enumerator. | read-write |
| imageSpaceAfter | Space After applied to images. Can return: Real (0 - 8640) or NothingEnum enumerator. | read-write |
| imageSpaceBefore | Space Before applied to images. Can return: Real (0 - 8640) or NothingEnum enumerator. | read-write |
| includeInsideEdges | 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. | read-write |
| insetSpacing | 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. | read-write |
| inverse | If true, inverts the text wrap. Can return: Boolean or NothingEnum enumerator. | read-write |
| isValid | bool Returns true if the object specifier resolves to valid objects. | read-only |
| jpegOptionsFormat | The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. Can return: JPEGOptionsFormat enumerator or NothingEnum enumerator. | read-write |
| jpegOptionsQuality | The quality of converted JPEG images. Note: Not valid when image conversion is GIF. . Can return: JPEGOptionsQuality enumerator or NothingEnum enumerator. | read-write |
| leftArrowHeadScale | The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. | read-write |
| leftCrop | The amount in measurement units to crop the left edge of a graphic. Can return: Unit or NothingEnum enumerator. | read-write |
| leftLineEnd | The arrowhead applied to the start of the path. . Can return: ArrowHead enumerator or NothingEnum enumerator. | read-write |
| lockPosition | If true, prevents manual positioning of the anchored object. Can return: Boolean or NothingEnum enumerator. | read-write |
| minimumFirstBaselineOffset | 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. | read-write |
| minimumHeightForAutoSizing | The minimum height for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator. | read-write |
| minimumSpacingOption | Minimum Spacing Before First Footnote. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. | read-write |
| minimumWidthForAutoSizing | The minimum width for auto-sizing of the text frame. Can return: Unit or NothingEnum enumerator. | read-write |
| miterLimit = 4 | 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. | read-write |
| nonprinting | If true, the FindObjectPreference does not print. Can return: Boolean or NothingEnum enumerator. | read-write |
| opticalMarginAlignment | If true, adjust the position of characters at the edges of the frame to provide a better appearance. Can return: Boolean or NothingEnum enumerator. | read-write |
| opticalMarginSize | 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. | read-write |
| overprintFill | 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. | read-write |
| overprintGap | 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. | read-write |
| overprintStroke | 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. | read-write |
| parent | Application The parent of the FindObjectPreference (a Application). | read-only |
| pinPosition | If true, pins the position of the anchored object within the text frame top and bottom. Can return: Boolean or NothingEnum enumerator. | read-write |
| positionReferencePoint | 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. | read-write |
| preferences | Preferences A collection of preferences objects. | read-only |
| preserveAppearanceFromLayout | Preserve Appearance from Layout. Can return: PreserveAppearanceFromLayoutEnum enumerator or NothingEnum enumerator. | read-write |
| properties | Object A property that allows setting of several properties at the same time. | read-write |
| rightArrowHeadScale | The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. | read-write |
| rightCrop | The amount in measurement units to crop the right edge of a graphic. Can return: Unit or NothingEnum enumerator. | read-write |
| rightLineEnd | The arrowhead applied to the end of the path. Can return: ArrowHead enumerator or NothingEnum enumerator. | read-write |
| spaceBetweenFootnotes | Space between footnotes. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. | read-write |
| spanFootnotesAcross | If true, enable straddling footnotes. Can return: Boolean or NothingEnum enumerator. | read-write |
| spineRelative | 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. | read-write |
| startingOffsetForBaselineFrameGrid | The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. | read-write |
| storyDirection | The direction of the story. Can return: StoryDirectionOptions enumerator or NothingEnum enumerator. | read-write |
| strokeAlignment | The stroke alignment applied to the FindObjectPreference. Can return: StrokeAlignment enumerator or NothingEnum enumerator. | read-write |
| strokeColor | 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. | read-write |
| strokeCornerAdjustment | The corner adjustment applied to the FindObjectPreference. Can return: StrokeCornerAdjustment enumerator or NothingEnum enumerator. | read-write |
| strokeDashAndGap | 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. | read-write |
| strokeTint | 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. | read-write |
| strokeTransparencySettings | Transparency settings for the stroke. Can return: FindChangeStrokeTransparencySetting or NothingEnum enumerator. | read-only |
| strokeType | The name of the stroke style to apply. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. | read-write |
| strokeWeight | The weight (in points) to apply to the FindObjectPreference's stroke. Can return: Unit or NothingEnum enumerator. | read-write |
| textColumnCount | 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. | read-write |
| textColumnFixedWidth | The column width of the columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. | read-write |
| textColumnGutter | The space between columns in the text frame. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. | read-write |
| textWrapMode | The text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum enumerator. | read-write |
| textWrapOffset | 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. | read-write |
| textWrapSide | Text wrap side options. Can return: TextWrapSideOptions enumerator or NothingEnum enumerator. | read-write |
| topCrop | The amount in measurement units to crop the top edge of a graphic. Can return: Unit or NothingEnum enumerator. | read-write |
| topLeftCornerOption | 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. | read-write |
| topLeftCornerRadius | 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. | read-write |
| topRightCornerOption | The shape to apply to the top right corner of rectangular shapes. Can return: CornerOptions enumerator or NothingEnum enumerator. | read-write |
| topRightCornerRadius | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes. Can return: Unit or NothingEnum enumerator. | read-write |
| transparencySettings | Transparency settings. Can return: FindChangeTransparencySetting or NothingEnum enumerator. | read-only |
| useCustomBaselineFrameGrid | If true, uses a custom baseline frame grid. Can return: Boolean or NothingEnum enumerator. | read-write |
| useFixedColumnWidth | 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. | read-write |
| useImagePageBreak | If true, image page break settings will be used in objects. Can return: Boolean or NothingEnum enumerator. | read-write |
| useMinimumHeightForAutoSizing | If true, minimum height value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator. | read-write |
| useMinimumWidthForAutoSizing | If true, minimum width value is used during the auto-sizing of text frame. . Can return: Boolean or NothingEnum enumerator. | read-write |
| useNoLineBreaksForAutoSizing | If true, line-breaks are not introduced after auto sizing. . Can return: Boolean or NothingEnum enumerator. | read-write |
| userModifiedWrap | If true, the text wrap path has been explicitly modified by the user. Can return: Boolean or NothingEnum enumerator. | read-only |
| verticalJustification | The vertical alignment of the text content. . Can return: VerticalJustification enumerator or NothingEnum enumerator. | read-write |
| verticalReferencePoint | The vertical reference point on the page. Valid when anchored position is custom. Can return: VerticallyRelativeTo enumerator or NothingEnum enumerator. | read-write |
| verticalThreshold | 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. | read-write |
Methods
| actualText( | ) |
→ string |
| addEventListener( | eventType, handler [, captures]) |
→ EventListener |
| altText( | ) |
→ string |
| removeEventListener( | eventType, handler [, captures]) |
→ bool |
| toSource( | ) |
→ string |
| toSpecifier( | ) |
→ string |
-
actualText( )→ string -
Provides the actual text for the object
-
addEventListener( eventType, handler [, captures=false])→ EventListener -
Adds an event listener.
eventTypestring The event type. handlerThe event handler. Can accept: File or JavaScript Function. capturesbool This parameter is obsolete. (Optional) -
altText( )→ string -
Provides the alternate text for the object
-
getElements( )→ FindObjectPreference -
Resolves the object specifier, creating an array of object references.
-
removeEventListener( eventType, handler [, captures=false])→ bool -
Removes the event listener.
eventTypestring The registered event type. handlerThe registered event handler. Can accept: File or JavaScript Function. capturesbool This parameter is obsolete. (Optional) -
toSource( )→ string -
Generates a string which, if executed, will return the FindObjectPreference.
-
toSpecifier( )→ string -
Retrieves the object specifier.