Adobe InDesign CS4 (6.0) Object Model JS: FindGrepPreference

InDesign CS4

Class

FindGrepPreference

 Find grep preferences. Base Class: Preference

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application
Preference
FindGrepPreference
Bullet | NumberingRestartPolicy

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyleNothingEnum
String
r/wThe character style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: CharacterStyle.
appliedConditionsNothingEnum
Strings
r/wThe conditions to search for or change to. Specify the "nothing" enum for "Any" or an empty list for "[Unconditional]". Can return: Array of Strings or NothingEnum enumerator. Can also accept: Array of Conditions.
appliedFontFont
NothingEnum
String
r/wThe font applied to the text, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator.
appliedLanguageLanguage
LanguageWithVendors
NothingEnum
String
r/wThe language to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Language or LanguageWithVendors.
appliedNumberingListNothingEnum
NumberingList
String
r/wThe list to be part of. Can return: NumberingList, String or NothingEnum enumerator.
appliedParagraphStyleNothingEnum
ParagraphStyle
String
r/wThe paragraph style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: ParagraphStyle.
autoLeadingNothingEnum
Real
r/wThe percent of the type size to use for auto leading. (Range: 0 to 500). Can return: Real or NothingEnum enumerator.
balanceRaggedLinesBalanceLinesStyle
Boolean
NothingEnum
r/wIf 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.
baselineShiftNothingEnum
Unit
r/wThe baseline shift applied to the text. Can return: Unit or NothingEnum enumerator.
bulletCharBullet
NothingEnum
r/wBullet character. Can return: Bullet or NothingEnum enumerator.
bulletsAndNumberingListTypeListType
NothingEnum
r/wList type for bullets and numbering. Can return: ListType enumerator or NothingEnum enumerator.
bulletsCharacterStyleCharacterStyle
NothingEnum
String
r/wThe character style to be used for the text after string. Can return: CharacterStyle, String or NothingEnum enumerator.
bulletsTextAfterNothingEnum
String
r/wThe text after string expression for bullets. Can return: String or NothingEnum enumerator.
capitalizationCapitalization
NothingEnum
r/wThe capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator.
characterDirectionCharacterDirectionOptions
NothingEnum
r/wThe direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
composerNothingEnum
String
r/wThe text composer to use to compose the text. Can return: String or NothingEnum enumerator.
diacriticPositionDiacriticPositionOptions
NothingEnum
r/wPosition of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator.
digitsTypeDigitsTypeOptions
NothingEnum
r/wThe digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator.
dropCapCharactersNothingEnum
Short Integer (0 - 150)
r/wThe number of characters to drop cap. Can return: Short Integer (0 - 150) or NothingEnum enumerator.
dropCapLinesNothingEnum
Short Integer (0 - 25)
r/wThe number of lines to drop cap. Can return: Short Integer (0 - 25) or NothingEnum enumerator.
dropcapDetailLong Integer
NothingEnum
r/wDetails about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. Can return: Long Integer or NothingEnum enumerator.
endJoinNothingEnum
OutlineJoin
r/wThe stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator.
fillColorNothingEnum
String
Swatch
r/wThe 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.
fillTintNothingEnum
Real
r/wThe tint (as a percentage) of the fill color of the text. (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.
findWhatNothingEnum
String
r/wThe FindGrepPreference to find. Can return: String or NothingEnum enumerator.
firstLineIndentNothingEnum
Unit
r/wThe amount to indent the first line. Can return: Unit or NothingEnum enumerator.
fontStyleNothingEnum
String
r/wThe name of the font style. Can return: String or NothingEnum enumerator.
gradientFillAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientFillLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. Can return: Real or NothingEnum enumerator.
gradientFillStart2 Units
NothingEnum
r/wThe 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.
gradientStrokeAngleNothingEnum
Real
r/wThe angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator.
gradientStrokeLengthNothingEnum
Real
r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. Can return: Real or NothingEnum enumerator.
gradientStrokeStart2 Units
NothingEnum
r/wThe 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.
horizontalScaleNothingEnum
Real
r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.
hyphenateAcrossColumnsBoolean
NothingEnum
r/wIf true, allows the last word in a text column to be hyphenated. Can return: Boolean or NothingEnum enumerator.
hyphenateLastWordBoolean
NothingEnum
r/wIf true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: Boolean or NothingEnum enumerator.
ignoreEdgeAlignmentBoolean
NothingEnum
r/wIf true, ignores optical edge alignment for the paragraph. Can return: Boolean or NothingEnum enumerator.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
justificationJustification
NothingEnum
r/wThe paragraph alignment. Can return: Justification enumerator or NothingEnum enumerator.
kashidasKashidasOptions
NothingEnum
r/wUse of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator.
keepAllLinesTogetherBoolean
NothingEnum
r/wIf true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. Can return: Boolean or NothingEnum enumerator.
keepFirstLinesNothingEnum
Short Integer (1 - 50)
r/wThe minimum number of lines to keep together in a paragraph before allowing a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator.
keepLastLinesNothingEnum
Short Integer (1 - 50)
r/wThe minimum number of lines to keep together in a paragraph after a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator.
keepLinesTogetherBoolean
NothingEnum
r/wIf true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: Boolean or NothingEnum enumerator.
keepRuleAboveInFrameBoolean
NothingEnum
r/wIf true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. Can return: Boolean or NothingEnum enumerator.
keepWithNextNothingEnum
Short Integer (0 - 5)
r/wThe minimum number of lines to keep with the next paragraph. Can return: Short Integer (0 - 5) or NothingEnum enumerator.
kerningMethodNothingEnum
String
r/wThe type of pair kerning. Can return: String or NothingEnum enumerator.
kerningValueNothingEnum
Real
r/wThe amount of space to add or remove between characters, specified in thousands of an em. . Can return: Real or NothingEnum enumerator.
keyboardDirectionCharacterDirectionOptions
NothingEnum
r/wThe keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator.
lastLineIndentNothingEnum
Unit
r/wThe amount to indent the last line in the paragraph. Can return: Unit or NothingEnum enumerator.
leadingLeading
NothingEnum
Unit
r/wThe leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator.
leftIndentNothingEnum
Unit
r/wThe width of the left indent. Can return: Unit or NothingEnum enumerator.
ligaturesBoolean
NothingEnum
r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator.
miterLimitNothingEnum
Real (0 - 1000)
r/wThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - 1000) or NothingEnum enumerator. (default: 4)
noBreakBoolean
NothingEnum
r/wIf true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator.
numberingApplyRestartPolicyBoolean
NothingEnum
r/wIf true, apply the numbering restart policy. Can return: Boolean or NothingEnum enumerator.
numberingCharacterStyleCharacterStyle
NothingEnum
String
r/wThe character style to be used for the number string. Can return: CharacterStyle, String or NothingEnum enumerator.
numberingContinueBoolean
NothingEnum
r/wContinue the numbering at this level. Can return: Boolean or NothingEnum enumerator.
numberingExpressionNothingEnum
String
r/wThe number string expression for numbering. Can return: String or NothingEnum enumerator.
numberingFormatNothingEnum
NumberingStyle
String
r/wNumbering format options. Can return: NumberingStyle enumerator, String or NothingEnum enumerator.
numberingLevelLong Integer
NothingEnum
r/wThe level of the paragraph. Can return: Long Integer or NothingEnum enumerator.
numberingRestartPoliciesNothingEnum
NumberingRestartPolicy
readonlyNumbering restart policies. Can return: NumberingRestartPolicy or NothingEnum enumerator.
numberingStartAtLong Integer
NothingEnum
r/wDetermines starting number in a numbered list. Can return: Long Integer or NothingEnum enumerator.
otfContextualAlternateBoolean
NothingEnum
r/wIf true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfDiscretionaryLigatureBoolean
NothingEnum
r/wIf true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfFigureStyleNothingEnum
OTFFigureStyle
r/wThe figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator.
otfFractionBoolean
NothingEnum
r/wIf true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfHistoricalBoolean
NothingEnum
r/wIf true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfJustificationAlternateBoolean
NothingEnum
r/wIf true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfLocaleBoolean
NothingEnum
r/wIf true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfMarkBoolean
NothingEnum
r/wIf true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOrdinalBoolean
NothingEnum
r/wIf true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfOverlapSwashBoolean
NothingEnum
r/wIf true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfSlashedZeroBoolean
NothingEnum
r/wIf true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStretchedAlternateBoolean
NothingEnum
r/wIf true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticAlternateBoolean
NothingEnum
r/wIf true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfStylisticSetsLong Integer
NothingEnum
r/wThe stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator.
otfSwashBoolean
NothingEnum
r/wIf true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
otfTitlingBoolean
NothingEnum
r/wIf true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator.
overprintFillBoolean
NothingEnum
r/wIf true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
overprintStrokeBoolean
NothingEnum
r/wIf true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator.
paragraphDirectionNothingEnum
ParagraphDirectionOptions
r/wParagraph direction. Can return: ParagraphDirectionOptions enumerator or NothingEnum enumerator.
paragraphJustificationNothingEnum
ParagraphJustificationOptions
r/wParagraph justification. Can return: ParagraphJustificationOptions enumerator or NothingEnum enumerator.
parentApplication readonlyThe parent of the FindGrepPreference (a Application).
pointSizeNothingEnum
Unit
r/wThe text size. Can return: Unit or NothingEnum enumerator.
positionNothingEnum
Position
r/wThe text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator.
positionalFormNothingEnum
PositionalForms
r/wThe OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightIndentNothingEnum
Unit
r/wThe width of the right indent. Can return: Unit or NothingEnum enumerator.
singleWordJustificationNothingEnum
SingleWordJustification
r/wThe alignment to use for lines that contain a single word. Can return: SingleWordJustification enumerator or NothingEnum enumerator.
skewNothingEnum
Real
r/wThe skew angle of the text. (Range: -85 to 85). Can return: Real or NothingEnum enumerator.
spaceAfterNothingEnum
Unit
r/wThe height of the paragraph space below. Can return: Unit or NothingEnum enumerator.
spaceBeforeNothingEnum
Unit
r/wThe height of the paragraph space above. Can return: Unit or NothingEnum enumerator.
startParagraphNothingEnum
StartParagraph
r/wThe location at which to start the paragraph. Can return: StartParagraph enumerator or NothingEnum enumerator.
strikeThroughColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator.
strikeThroughGapOverprintBoolean
NothingEnum
r/wIf 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.
strikeThroughGapTintNothingEnum
Real
r/wThe 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.
strikeThroughOffsetNothingEnum
Unit
r/wThe amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator.
strikeThroughOverprintBoolean
NothingEnum
r/wIf true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator.
strikeThroughTintNothingEnum
Real
r/wThe tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
strikeThroughTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
strikeThroughWeightNothingEnum
Unit
r/wThe stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator.
strikeThruBoolean
NothingEnum
r/wIf true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator.
strokeAlignmentNothingEnum
TextStrokeAlign
r/wThe stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator.
strokeColorNothingEnum
String
Swatch
r/wThe 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.
strokeTintNothingEnum
Real
r/wThe tint (as a percentage) of the stroke color of the text. (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.
strokeWeightNothingEnum
Unit
r/wThe stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator.
trackingNothingEnum
Real
r/wThe amount by which to loosen or tighten a block of text, specified in thousands of an em. Can return: Real or NothingEnum enumerator.
underlineBoolean
NothingEnum
r/wIf true, underlines the text. Can return: Boolean or NothingEnum enumerator.
underlineColorNothingEnum
String
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator.
underlineGapColorNothingEnum
String
Swatch
r/wThe 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.
underlineGapOverprintBoolean
NothingEnum
r/wIf true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator.
underlineGapTintNothingEnum
Real
r/wThe 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.
underlineOffsetNothingEnum
Unit
r/wThe amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator.
underlineOverprintBoolean
NothingEnum
r/wIf true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator.
underlineTintNothingEnum
Real
r/wThe underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator.
underlineTypeNothingEnum
String
StrokeStyle
r/wThe stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator.
underlineWeightNothingEnum
Unit
r/wThe stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator.
verticalScaleNothingEnum
Real
r/wThe vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator.
xOffsetDiacriticNothingEnum
Real
r/wThe x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.
yOffsetDiacriticNothingEnum
Real
r/wThe y (vertical) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator.

Methods

Instances

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.findGrepPreferences

Bullet.parent

NumberingRestartPolicy.parent

Return

Array of FindGrepPreference FindGrepPreference.getElements ()

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