Class
Find grep preferences. Base Class: Preference getElements, toSource, toSpecifier
FindGrepPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedCharacterStyle | CharacterStyleNothingEnum String |
r/w | The character style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: CharacterStyle. |
| appliedConditions | NothingEnum Strings |
r/w | The 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. |
| appliedFont | Font NothingEnum String |
r/w | The font applied to the text, specified as either a font object or the name of font family. Can return: Font, String or NothingEnum enumerator. |
| appliedLanguage | Language LanguageWithVendors NothingEnum String |
r/w | The language to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: Language or LanguageWithVendors. |
| appliedNumberingList | NothingEnum NumberingList String |
r/w | The list to be part of. Can return: NumberingList, String or NothingEnum enumerator. |
| appliedParagraphStyle | NothingEnum ParagraphStyle String |
r/w | The paragraph style to search for or change to. Can return: String or NothingEnum enumerator. Can also accept: ParagraphStyle. |
| autoLeading | NothingEnum Real |
r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). Can return: Real or NothingEnum enumerator. |
| balanceRaggedLines | BalanceLinesStyle Boolean NothingEnum |
r/w | 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 | NothingEnum Unit |
r/w | The baseline shift applied to the text. Can return: Unit or NothingEnum enumerator. |
| bulletChar | Bullet NothingEnum |
r/w | Bullet character. Can return: Bullet or NothingEnum enumerator. |
| bulletsAndNumberingListType | ListType NothingEnum |
r/w | List type for bullets and numbering. Can return: ListType enumerator or NothingEnum enumerator. |
| bulletsCharacterStyle | CharacterStyle NothingEnum String |
r/w | The character style to be used for the text after string. Can return: CharacterStyle, String or NothingEnum enumerator. |
| bulletsTextAfter | NothingEnum String |
r/w | The text after string expression for bullets. Can return: String or NothingEnum enumerator. |
| capitalization | Capitalization NothingEnum |
r/w | The capitalization scheme. Can return: Capitalization enumerator or NothingEnum enumerator. |
| characterDirection | CharacterDirectionOptions NothingEnum |
r/w | The direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| composer | NothingEnum String |
r/w | The text composer to use to compose the text. Can return: String or NothingEnum enumerator. |
| diacriticPosition | DiacriticPositionOptions NothingEnum |
r/w | Position of diacriticical characters. Can return: DiacriticPositionOptions enumerator or NothingEnum enumerator. |
| digitsType | DigitsTypeOptions NothingEnum |
r/w | The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum enumerator. |
| dropCapCharacters | NothingEnum Short Integer (0 - 150) |
r/w | The number of characters to drop cap. Can return: Short Integer (0 - 150) or NothingEnum enumerator. |
| dropCapLines | NothingEnum Short Integer (0 - 25) |
r/w | The number of lines to drop cap. Can return: Short Integer (0 - 25) or NothingEnum enumerator. |
| dropcapDetail | Long Integer NothingEnum |
r/w | Details 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. |
| endJoin | NothingEnum OutlineJoin |
r/w | The stroke join type applied to the characters of the text. Can return: OutlineJoin enumerator or NothingEnum enumerator. |
| fillColor | NothingEnum String Swatch |
r/w | 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 | NothingEnum Real |
r/w | The 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. |
| findWhat | NothingEnum String |
r/w | The FindGrepPreference to find. Can return: String or NothingEnum enumerator. |
| firstLineIndent | NothingEnum Unit |
r/w | The amount to indent the first line. Can return: Unit or NothingEnum enumerator. |
| fontStyle | NothingEnum String |
r/w | The name of the font style. Can return: String or NothingEnum enumerator. |
| gradientFillAngle | NothingEnum Real |
r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientFillLength | NothingEnum Real |
r/w | 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 | 2 Units NothingEnum |
r/w | 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 | NothingEnum Real |
r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. |
| gradientStrokeLength | NothingEnum Real |
r/w | 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 | 2 Units NothingEnum |
r/w | 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 | NothingEnum Real |
r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. |
| hyphenateAcrossColumns | Boolean NothingEnum |
r/w | If true, allows the last word in a text column to be hyphenated. Can return: Boolean or NothingEnum enumerator. |
| hyphenateLastWord | Boolean NothingEnum |
r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. Can return: Boolean or NothingEnum enumerator. |
| ignoreEdgeAlignment | Boolean NothingEnum |
r/w | If true, ignores optical edge alignment for the paragraph. Can return: Boolean or NothingEnum enumerator. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| justification | Justification NothingEnum |
r/w | The paragraph alignment. Can return: Justification enumerator or NothingEnum enumerator. |
| kashidas | KashidasOptions NothingEnum |
r/w | Use of Kashidas for justification. Can return: KashidasOptions enumerator or NothingEnum enumerator. |
| keepAllLinesTogether | Boolean NothingEnum |
r/w | 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 | NothingEnum Short Integer (1 - 50) |
r/w | The minimum number of lines to keep together in a paragraph before allowing a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. |
| keepLastLines | NothingEnum Short Integer (1 - 50) |
r/w | The minimum number of lines to keep together in a paragraph after a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. |
| keepLinesTogether | Boolean NothingEnum |
r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. Can return: Boolean or NothingEnum enumerator. |
| keepRuleAboveInFrame | Boolean NothingEnum |
r/w | If 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. |
| keepWithNext | NothingEnum Short Integer (0 - 5) |
r/w | The minimum number of lines to keep with the next paragraph. Can return: Short Integer (0 - 5) or NothingEnum enumerator. |
| kerningMethod | NothingEnum String |
r/w | The type of pair kerning. Can return: String or NothingEnum enumerator. |
| kerningValue | NothingEnum Real |
r/w | The amount of space to add or remove between characters, specified in thousands of an em. . Can return: Real or NothingEnum enumerator. |
| keyboardDirection | CharacterDirectionOptions NothingEnum |
r/w | The keyboard direction of the character. Can return: CharacterDirectionOptions enumerator or NothingEnum enumerator. |
| lastLineIndent | NothingEnum Unit |
r/w | The amount to indent the last line in the paragraph. Can return: Unit or NothingEnum enumerator. |
| leading | Leading NothingEnum Unit |
r/w | The leading applied to the text. Can return: Unit, Leading enumerator or NothingEnum enumerator. |
| leftIndent | NothingEnum Unit |
r/w | The width of the left indent. Can return: Unit or NothingEnum enumerator. |
| ligatures | Boolean NothingEnum |
r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. Can return: Boolean or NothingEnum enumerator. |
| miterLimit | NothingEnum Real (0 - 1000) |
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 (0 - 1000) or NothingEnum enumerator. (default: 4) |
| noBreak | Boolean NothingEnum |
r/w | If true, keeps the text on the same line. . Can return: Boolean or NothingEnum enumerator. |
| numberingApplyRestartPolicy | Boolean NothingEnum |
r/w | If true, apply the numbering restart policy. Can return: Boolean or NothingEnum enumerator. |
| numberingCharacterStyle | CharacterStyle NothingEnum String |
r/w | The character style to be used for the number string. Can return: CharacterStyle, String or NothingEnum enumerator. |
| numberingContinue | Boolean NothingEnum |
r/w | Continue the numbering at this level. Can return: Boolean or NothingEnum enumerator. |
| numberingExpression | NothingEnum String |
r/w | The number string expression for numbering. Can return: String or NothingEnum enumerator. |
| numberingFormat | NothingEnum NumberingStyle String |
r/w | Numbering format options. Can return: NumberingStyle enumerator, String or NothingEnum enumerator. |
| numberingLevel | Long Integer NothingEnum |
r/w | The level of the paragraph. Can return: Long Integer or NothingEnum enumerator. |
| numberingRestartPolicies | NothingEnum NumberingRestartPolicy |
readonly | Numbering restart policies. Can return: NumberingRestartPolicy or NothingEnum enumerator. |
| numberingStartAt | Long Integer NothingEnum |
r/w | Determines starting number in a numbered list. Can return: Long Integer or NothingEnum enumerator. |
| otfContextualAlternate | Boolean NothingEnum |
r/w | If true, uses contextual alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfDiscretionaryLigature | Boolean NothingEnum |
r/w | If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfFigureStyle | NothingEnum OTFFigureStyle |
r/w | The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or NothingEnum enumerator. |
| otfFraction | Boolean NothingEnum |
r/w | If true, uses fractions in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfHistorical | Boolean NothingEnum |
r/w | If true, use historical forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfJustificationAlternate | Boolean NothingEnum |
r/w | If true, use alternate justification forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfLocale | Boolean NothingEnum |
r/w | If true, uses localized forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfMark | Boolean NothingEnum |
r/w | If true, uses mark positioning in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOrdinal | Boolean NothingEnum |
r/w | If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfOverlapSwash | Boolean NothingEnum |
r/w | If true, use overlapping swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfSlashedZero | Boolean NothingEnum |
r/w | If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStretchedAlternate | Boolean NothingEnum |
r/w | If true, use stretched alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStylisticAlternate | Boolean NothingEnum |
r/w | If true, use stylistic alternate forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfStylisticSets | Long Integer NothingEnum |
r/w | The stylistic sets to use in OpenType fonts. Can return: Long Integer or NothingEnum enumerator. |
| otfSwash | Boolean NothingEnum |
r/w | If true, uses swash forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| otfTitling | Boolean NothingEnum |
r/w | If true, uses titling forms in OpenType fonts. Can return: Boolean or NothingEnum enumerator. |
| overprintFill | Boolean NothingEnum |
r/w | If true, the fill color of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| overprintStroke | Boolean NothingEnum |
r/w | If true, the stroke of the characters will overprint. Can return: Boolean or NothingEnum enumerator. |
| paragraphDirection | NothingEnum ParagraphDirectionOptions |
r/w | Paragraph direction. Can return: ParagraphDirectionOptions enumerator or NothingEnum enumerator. |
| paragraphJustification | NothingEnum ParagraphJustificationOptions |
r/w | Paragraph justification. Can return: ParagraphJustificationOptions enumerator or NothingEnum enumerator. |
| parent | Application | readonly | The parent of the FindGrepPreference (a Application). |
| pointSize | NothingEnum Unit |
r/w | The text size. Can return: Unit or NothingEnum enumerator. |
| position | NothingEnum Position |
r/w | The text position relative to the baseline. Can return: Position enumerator or NothingEnum enumerator. |
| positionalForm | NothingEnum PositionalForms |
r/w | The OpenType positional form. Can return: PositionalForms enumerator or NothingEnum enumerator. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightIndent | NothingEnum Unit |
r/w | The width of the right indent. Can return: Unit or NothingEnum enumerator. |
| singleWordJustification | NothingEnum SingleWordJustification |
r/w | The alignment to use for lines that contain a single word. Can return: SingleWordJustification enumerator or NothingEnum enumerator. |
| skew | NothingEnum Real |
r/w | The skew angle of the text. (Range: -85 to 85). Can return: Real or NothingEnum enumerator. |
| spaceAfter | NothingEnum Unit |
r/w | The height of the paragraph space below. Can return: Unit or NothingEnum enumerator. |
| spaceBefore | NothingEnum Unit |
r/w | The height of the paragraph space above. Can return: Unit or NothingEnum enumerator. |
| startParagraph | NothingEnum StartParagraph |
r/w | The location at which to start the paragraph. Can return: StartParagraph enumerator or NothingEnum enumerator. |
| strikeThroughColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. |
| strikeThroughGapColor | NothingEnum String Swatch |
r/w | 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 |
r/w | 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 | NothingEnum Real |
r/w | 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 | NothingEnum Unit |
r/w | The amount by which to offset the strikethrough stroke from the text baseline. Can return: Unit or NothingEnum enumerator. |
| strikeThroughOverprint | Boolean NothingEnum |
r/w | If true, the strikethrough stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| strikeThroughTint | NothingEnum Real |
r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| strikeThroughType | NothingEnum String StrokeStyle |
r/w | The stroke type of the strikethrough stroke. Can return: StrokeStyle, String or NothingEnum enumerator. |
| strikeThroughWeight | NothingEnum Unit |
r/w | The stroke weight of the strikethrough stroke. Can return: Unit or NothingEnum enumerator. |
| strikeThru | Boolean NothingEnum |
r/w | If true, draws a strikethrough line through the text. Can return: Boolean or NothingEnum enumerator. |
| strokeAlignment | NothingEnum TextStrokeAlign |
r/w | The stroke alignment applied to the text. Can return: TextStrokeAlign enumerator or NothingEnum enumerator. |
| strokeColor | NothingEnum String Swatch |
r/w | 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 | NothingEnum Real |
r/w | The 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. |
| strokeWeight | NothingEnum Unit |
r/w | The stroke weight applied to the characters of the text. Can return: Unit or NothingEnum enumerator. |
| tracking | NothingEnum Real |
r/w | 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 |
r/w | If true, underlines the text. Can return: Boolean or NothingEnum enumerator. |
| underlineColor | NothingEnum String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch, String or NothingEnum enumerator. |
| underlineGapColor | NothingEnum String Swatch |
r/w | 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 |
r/w | If true, the gap color of the underline stroke will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineGapTint | NothingEnum Real |
r/w | 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 | NothingEnum Unit |
r/w | The amount by which to offset the underline from the text baseline. Can return: Unit or NothingEnum enumerator. |
| underlineOverprint | Boolean NothingEnum |
r/w | If true, the underline stroke color will overprint. Can return: Boolean or NothingEnum enumerator. |
| underlineTint | NothingEnum Real |
r/w | The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. |
| underlineType | NothingEnum String StrokeStyle |
r/w | The stroke type of the underline stroke. Can return: StrokeStyle, String or NothingEnum enumerator. |
| underlineWeight | NothingEnum Unit |
r/w | The stroke weight of the underline stroke. Can return: Unit or NothingEnum enumerator. |
| verticalScale | NothingEnum Real |
r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000). Can return: Real or NothingEnum enumerator. |
| xOffsetDiacritic | NothingEnum Real |
r/w | The x (horizontal) offset for diacritic adjustment. Can return: Real or NothingEnum enumerator. |
| yOffsetDiacritic | NothingEnum Real |
r/w | The 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.3d | Contents :: Index |