FindObjectPreference

Find object preferences.

Go to Property Listing | Method Listing

Methods:

Property Listing

Property	Type	Access	Description
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.
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.
contentTransparencySettings	ContentTransparencySetting NothingEnum.NOTHING	readonly	Transparency settings for the content of the FindObjectPreference. Can return: ContentTransparencySetting 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.
cornerOption	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 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.
cornerRadius	Unit NothingEnum.NOTHING	read/write	The radius in measurement units of the corner effect. Can return: Unit 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.
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	FillTransparencySetting NothingEnum.NOTHING	readonly	Transparency settings for the fill applied to the FindObjectPreference. Can return: FillTransparencySetting 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.
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.
horizontalAlignment	HorizontalAlignment HorizontalAlignment.CENTER_ALIGN HorizontalAlignment.LEFT_ALIGN HorizontalAlignment.RIGHT_ALIGN HorizontalAlignment.TEXT_ALIGN NothingEnum.NOTHING	read/write	When 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.
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.
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.
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.
miterLimit	Real (range 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. (Range: 1 to 500). Can return: Real 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.
properties	Object	read/write	A property that allows setting of several properties at the same time.
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.
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.
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	StrokeTransparencySetting NothingEnum.NOTHING	readonly	Transparency settings for the stroke. Can return: StrokeTransparencySetting 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.
textWrapOffset	Array of Units Unit NothingEnum.NOTHING	read/write	The 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.
textWrapType	TextWrapTypes TextWrapTypes.BOUNDING_BOX_TEXT_WRAP TextWrapTypes.CONTOUR TextWrapTypes.JUMP_OBJECT_TEXT_WRAP TextWrapTypes.NEXT_COLUMN_TEXT_WRAP TextWrapTypes.NONE TextWrapTypes.USER_MODIFIED NothingEnum.NOTHING	read/write	The text wrap type. . Can return: TextWrapTypes 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.
transparencySettings	TransparencySetting NothingEnum.NOTHING	readonly	Transparency settings. Can return: TransparencySetting 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.
verticalAlignment	VerticalAlignment VerticalAlignment.BOTTOM_ALIGN VerticalAlignment.CENTER_ALIGN VerticalAlignment.TOP_ALIGN NothingEnum.NOTHING	read/write	The 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.
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.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.