FindPreference

Preferences for searching for text or attributes.

Methods:

getElements, toSource, toSpecifier

Objects:

AutoEnum, BalanceLinesStyle, Boolean, Bullet, Capitalization, Font, Justification, LanguageWithVendors, Leading, ListType, NothingEnum, NumberingStyle, OTFFigureStyle, Object, Position, SingleWordJustification, StartParagraph, String, StrokeStyle, Swatch,

Property Listing

Property

Type

Access

Description

alignToBaseline

Boolean

NothingEnum.NOTHING

read/write

If true, aligns the baseline of the text to the baseline grid. Can return: Boolean or NothingEnum enumerator.

appliedCharacterStyle

String

NothingEnumCanalsoaccept:CharacterStyle

read/write

The character style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: CharacterStyle.

appliedFont

Font

String

NothingEnum.NOTHING

read/write

The font applied to the FindPreference, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.

appliedLanguage

String

LanguageWithVendors

NothingEnumCanalsoaccept:Language

read/write

The language to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Language or LanguageWithVendors.

appliedParagraphStyle

String

NothingEnumCanalsoaccept:ParagraphStyle

read/write

The paragraph style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: ParagraphStyle.

autoLeading

Real (range 0 - 500)

NothingEnum.NOTHING

read/write

The percent of the type size to use for auto leading. (Range: 0 to 500). Can return: Real or NothingEnum enumerator.

balanceRaggedLines

BalanceLinesStyle

BalanceLinesStyle.FULLY_BALANCED

BalanceLinesStyle.NO_BALANCING

BalanceLinesStyle.PYRAMID_SHAPE

BalanceLinesStyle.VEE_SHAPE

Boolean

NothingEnum.NOTHING

read/write

If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean, BalanceLinesStyle enumerator or NothingEnum enumerator.

baselineShift

Unit

NothingEnum.NOTHING

read/write

The baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.

bulletChar

Bullet

NothingEnum.NOTHING

read/write

Bullet character. Can return: Bullet or NothingEnum enumerator.

bulletsAndNumberingColor

AutoEnum

AutoEnum.AUTO_VALUE

String

Swatch

NothingEnum.NOTHING

read/write

Color of the bullet or number character. Can return: AutoEnum enumerator, Swatch, String or NothingEnum enumerator.

bulletsAndNumberingListType

ListType

ListType.BULLET_LIST

ListType.NO_LIST

ListType.NUMBERED_LIST

NothingEnum.NOTHING

read/write

List type for bullets and numbering. Can return: ListType enumerator or NothingEnum enumerator.

bulletsAndNumberingSize

AutoEnum

AutoEnum.AUTO_VALUE

Real

NothingEnum.NOTHING

read/write

Point size of the bullet or number character. Can return: AutoEnum enumerator, Real or NothingEnum enumerator.

capitalization

Capitalization

Capitalization.ALL_CAPS

Capitalization.CAP_TO_SMALL_CAP

Capitalization.NORMAL

Capitalization.SMALL_CAPS

NothingEnum.NOTHING

read/write

The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.

caseSensitive

Boolean

NothingEnum.NOTHING

read/write

If true, finds strings whose use of case matches the find text string. If false, finds strings that match the find text string regardless of case. . Can return: Boolean or NothingEnum enumerator.

composer

String

NothingEnum.NOTHING

read/write

The text composer to use to compose the text. Can return: String or NothingEnum enumerator.

dropCapCharacters

Short

NothingEnum.NOTHING

read/write

Number of characters for drop cap. Can return: Short or NothingEnum enumerator.

dropCapLines

Short

NothingEnum.NOTHING

read/write

Number of lines for drop cap. Can return: Short or NothingEnum enumerator.

fillColor

String

NothingEnumCanalsoaccept:Swatch

read/write

The swatch (color, gradient, tint, or mixed ink), applied as a fill color, to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Swatch.

fillTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The tint (as a percentage) of the fill color of the FindPreference. (To specify a tint percentage, 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.

findText

String

NothingEnum.NOTHING

read/write

The text string to find. Can return: String or NothingEnum enumerator.

firstLineIndent

Unit

NothingEnum.NOTHING

read/write

The amount to indent the first line. Can return: Unit or NothingEnum enumerator.

fontStyle

String

NothingEnum.NOTHING

read/write

The name of the font style. Can return: String or NothingEnum enumerator.

gradientFillAngle

Real

NothingEnum.NOTHING

read/write

The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.

gradientFillLength

Real

NothingEnum.NOTHING

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator.

gradientFillStart

Array of 2 Units

NothingEnum.NOTHING

read/write

The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator.

gradientStrokeAngle

Real

NothingEnum.NOTHING

read/write

The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.

gradientStrokeLength

Real

NothingEnum.NOTHING

read/write

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator.

gradientStrokeStart

Array of 2 Units

NothingEnum.NOTHING

read/write

The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator.

horizontalScale

Real

NothingEnum.NOTHING

read/write

The horizontal scaling applied to the FindPreference. Can return: Real or NothingEnum enumerator.

hyphenateLastWord

Boolean

NothingEnum.NOTHING

read/write

If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: Boolean or NothingEnum enumerator.

justification

Justification

Justification.AWAY_FROM_BINDING_SIDE

Justification.CENTER_ALIGN

Justification.CENTER_JUSTIFIED

Justification.FULLY_JUSTIFIED

Justification.LEFT_ALIGN

Justification.LEFT_JUSTIFIED

Justification.RIGHT_ALIGN

Justification.RIGHT_JUSTIFIED

Justification.TO_BINDING_SIDE

NothingEnum.NOTHING

read/write

The paragraph alignment. Can return: Justification enumerator or NothingEnum enumerator.

keepAllLinesTogether

Boolean

NothingEnum.NOTHING

read/write

If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. Can return: Boolean or NothingEnum enumerator.

keepFirstLines

Short

NothingEnum.NOTHING

read/write

Keep at least this many lines together at the end of a column. Can return: Short or NothingEnum enumerator.

keepLastLines

Short

NothingEnum.NOTHING

read/write

Keep at least this many lines together at the start of a column. Can return: Short or NothingEnum enumerator.

keepLinesTogether

Boolean

NothingEnum.NOTHING

read/write

If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: Boolean or NothingEnum enumerator.

keepWithNext

Short

NothingEnum.NOTHING

read/write

Keep at least this many lines together with the following paragraph. Can return: Short or NothingEnum enumerator.

kerningMethod

String

NothingEnum.NOTHING

read/write

The type of pair kerning. Can return: String or NothingEnum enumerator.

kerningValue

Real

NothingEnum.NOTHING

read/write

The amount of space to add or remove between characters, specified in thousands of an em. . Can return: Real or NothingEnum enumerator.

lastLineIndent

Unit

NothingEnum.NOTHING

read/write

The amount to indent the last line in the paragraph. Can return: Unit or NothingEnum enumerator.

leading

Leading

Leading.AUTO

Unit

NothingEnum.NOTHING

read/write

The leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.

leftIndent

Unit

NothingEnum.NOTHING

read/write

The width of the left indent. Can return: Unit or NothingEnum enumerator.

ligatures

Boolean

NothingEnum.NOTHING

read/write

If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.

noBreak

Boolean

NothingEnum.NOTHING

read/write

If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.

numberSeparator

Short

NothingEnum.NOTHING

read/write

The numbering separator as a unicode ID. Can return: Short or NothingEnum enumerator.

numberStartAt

Long

NothingEnum.NOTHING

read/write

Starting number in a numbered list. Can return: Long or NothingEnum enumerator.

numberingFont

AutoEnum

AutoEnum.AUTO_VALUE

Font

String

NothingEnum.NOTHING

read/write

Font of the number character. Can return: Font, String, AutoEnum enumerator or NothingEnum enumerator.

numberingFontStyle

NothingEnum.NOTHING

String

AutoEnum

AutoEnum.AUTO_VALUE

read/write

Font style of the number character. Can return: String, NothingEnum enumerator or AutoEnum enumerator.

numberingStyle

NumberingStyle

NumberingStyle.ARABIC

NumberingStyle.LOWER_LETTERS

NumberingStyle.LOWER_ROMAN

NumberingStyle.UPPER_LETTERS

NumberingStyle.UPPER_ROMAN

String

NothingEnum.NOTHING

read/write

Numbering style. Can return: NumberingStyle enumerator, String or NothingEnum enumerator.

otfContextualAlternate

Boolean

NothingEnum.NOTHING

read/write

If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfDiscretionaryLigature

Boolean

NothingEnum.NOTHING

read/write

If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfFigureStyle

OTFFigureStyle

OTFFigureStyle.DEFAULT_VALUE

OTFFigureStyle.PROPORTIONAL_LINING

OTFFigureStyle.PROPORTIONAL_OLDSTYLE

OTFFigureStyle.TABULAR_LINING

OTFFigureStyle.TABULAR_OLDSTYLE

NothingEnum.NOTHING

read/write

The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.

otfFraction

Boolean

NothingEnum.NOTHING

read/write

If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfHistorical

Boolean

NothingEnum.NOTHING

read/write

If true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfOrdinal

Boolean

NothingEnum.NOTHING

read/write

If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfSlashedZero

Boolean

NothingEnum.NOTHING

read/write

If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfStylisticSets

Long

NothingEnum.NOTHING

read/write

The stylistic sets to use in OpenType fonts. Can return: Long or NothingEnum enumerator.

otfSwash

Boolean

NothingEnum.NOTHING

read/write

If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

otfTitling

Boolean

NothingEnum.NOTHING

read/write

If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.

overprintFill

Boolean

NothingEnum.NOTHING

read/write

If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.

overprintStroke

Boolean

NothingEnum.NOTHING

read/write

If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.

parent

Application

readonly

The parent of the FindPreference (a Application).

pointSize

Unit

NothingEnum.NOTHING

read/write

The text size. Can return: Unit or NothingEnum enumerator.

position

Position

Position.NORMAL

Position.OT_DENOMINATOR

Position.OT_NUMERATOR

Position.OT_SUBSCRIPT

Position.OT_SUPERSCRIPT

Position.SUBSCRIPT

Position.SUPERSCRIPT

NothingEnum.NOTHING

read/write

The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.

properties

Object

read/write

A property that allows setting of several properties at the same time.

rightIndent

Unit

NothingEnum.NOTHING

read/write

The width of the right indent. Can return: Unit or NothingEnum enumerator.

singleWordJustification

SingleWordJustification

SingleWordJustification.CENTER_ALIGN

SingleWordJustification.FULLY_JUSTIFIED

SingleWordJustification.LEFT_ALIGN

SingleWordJustification.RIGHT_ALIGN

NothingEnum.NOTHING

read/write

The alignment to use for lines that contain a single word. Can return: SingleWordJustification enumerator or NothingEnum enumerator.

skew

Real

NothingEnum.NOTHING

read/write

The skew angle of the FindPreference. Can return: Real or NothingEnum enumerator.

spaceAfter

Unit

NothingEnum.NOTHING

read/write

The height of the paragraph space below. Can return: Unit or NothingEnum enumerator.

spaceBefore

Unit

NothingEnum.NOTHING

read/write

The height of the paragraph space above. Can return: Unit or NothingEnum enumerator.

startParagraph

StartParagraph

StartParagraph.ANYWHERE

StartParagraph.NEXT_COLUMN

StartParagraph.NEXT_EVEN_PAGE

StartParagraph.NEXT_FRAME

StartParagraph.NEXT_ODD_PAGE

StartParagraph.NEXT_PAGE

NothingEnum.NOTHING

read/write

The location at which to start the paragraph. Can return: StartParagraph enumerator or NothingEnum enumerator.

strikeThroughColor

String

Swatch

NothingEnum.NOTHING

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.

strikeThroughGapColor

String

Swatch

NothingEnum.NOTHING

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.

strikeThroughGapOverprint

Boolean

NothingEnum.NOTHING

read/write

If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. Can return: Boolean or NothingEnum enumerator.

strikeThroughGapTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid. Can return: Real or NothingEnum enumerator.

strikeThroughOffset

Unit

NothingEnum.NOTHING

read/write

The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.

strikeThroughOverprint

Boolean

NothingEnum.NOTHING

read/write

If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.

strikeThroughTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.

strikeThroughType

String

StrokeStyle

NothingEnum.NOTHING

read/write

The stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.

strikeThroughWeight

Unit

NothingEnum.NOTHING

read/write

The stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.

strikeThru

Boolean

NothingEnum.NOTHING

read/write

If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.

strokeColor

String

NothingEnumCanalsoaccept:Swatch

read/write

The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Swatch.

strokeTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The tint (as a percentage) of the stroke color of the FindPreference. (To specify a tint percentage, 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.

strokeWeight

Unit

NothingEnum.NOTHING

read/write

The stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.

tracking

Real

NothingEnum.NOTHING

read/write

The amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator.

underline

Boolean

NothingEnum.NOTHING

read/write

If true, underlines the text. Can return: Boolean or NothingEnum enumerator.

underlineColor

String

Swatch

NothingEnum.NOTHING

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.

underlineGapColor

String

Swatch

NothingEnum.NOTHING

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch, String or NothingEnum enumerator.

underlineGapOverprint

Boolean

NothingEnum.NOTHING

read/write

If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.

underlineGapTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid. Can return: Real or NothingEnum enumerator.

underlineOffset

Unit

NothingEnum.NOTHING

read/write

The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.

underlineOverprint

Boolean

NothingEnum.NOTHING

read/write

If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.

underlineTint

Real (range 0 - 100)

NothingEnum.NOTHING

read/write

The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.

underlineType

String

StrokeStyle

NothingEnum.NOTHING

read/write

The stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.

underlineWeight

Unit

NothingEnum.NOTHING

read/write

The stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.

verticalScale

Real

NothingEnum.NOTHING

read/write

The vertical scaling applied to the FindPreference. Can return: Real or NothingEnum enumerator.

wholeWord

Boolean

NothingEnum.NOTHING

read/write

If true, finds only the complete find text string. If false, also finds strings that contain the find text string. Can return: Boolean or NothingEnum enumerator.

Method Listing

Object getElements ()

Resolves the object specifier, creating an array of object references.

String toSource ()

Generates a string which, if executed, will return the FindPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.findPreferences

Bullet.parent