Character
A text character.
Go to Property Listing | Method Listing
Methods:
addEventListener, applyCharacterStyle, applyConditions, applyParagraphStyle, asynchronousExportFile, autoTag, changeGlyph, changeGrep, changeText, changeTransliterate, changecase, clearOverrides, convertBulletsAndNumberingToText, convertToNote, convertToTable, createEmailQRCode, createHyperlinkQRCode, createOutlines, createPlainTextQRCode, createStyleThumbnailWithProperties, createTextMsgQRCode, createThumbnailWithProperties, createVCardQRCode, duplicate, exportFile, findGlyph, findGrep, findHyperlinks, findText, findTransliterate, getElements, isNthDesignAxisHidden, markup, move, place, recompose, remove, removeEventListener, select, setNthDesignAxis, showText, textHasOverrides, toSource, toSpecifier
Objects:
AdornmentOverprint, AlternateGlyphForms, BalanceLinesStyle, Boolean, Bullet, Buttons, Capitalization, CharacterAlignment, CharacterDirectionOptions, CharacterStyle, Characters, CheckBoxes, ComboBoxes, Condition, CornerOptions, DiacriticPositionOptions, DigitsTypeOptions, EPSTexts, EndCap, EndJoin, EndnoteRanges, EndnoteTextFrames, EventListeners, Events, Font, Footnotes, FormFields, Graphic, GraphicLines, GridAlignment, Groups, HiddenTexts, HyphenationStyleEnum, InsertionPoints, Justification, KashidasOptions, KentenAlignment, KentenCharacter, KentenCharacterSet, KinsokuHangTypes, KinsokuSet, KinsokuTable, KinsokuType, LanguageWithVendors, Leading, LeadingModel, Lines, ListAlignment, ListBoxes, ListType, MojikumiTable, MojikumiTableDefaults, MultiStateObjects, NestedGrepStyles, NestedLineStyles, NestedStyles, Notes, NothingEnum, Number, NumberingList, NumberingRestartPolicy, NumberingStyle, OTFFigureStyle, Object, OutlineJoin, Ovals, PageItem, PageItems, ParagraphBorderBottomOriginEnum, ParagraphBorderEnum, ParagraphBorderTopOriginEnum, ParagraphDirectionOptions, ParagraphJustificationOptions, ParagraphShadingBottomOriginEnum, ParagraphShadingTopOriginEnum, ParagraphShadingWidthEnum, ParagraphStyle, Paragraphs, Polygons, Position, PositionalForms, Preferences, RadioButtons, Rectangles, RubyAlignments, RubyKentenPosition, RubyOverhang, RubyParentSpacing, RubyTypes, RuleWidth, SignatureFields, SingleWordJustification, Spacing, SpanColumnCountOptions, SpanColumnTypeOptions, SpecialCharacters, SplineItems, StartParagraph, String, StrokeStyle, Swatch, TabStops, Tables, TextBoxes, TextColumns, TextFrames, TextPaths, TextStrokeAlign, TextStyleRanges, TextVariableInstances, Texts, WarichuAlignment, Words, XMLItem,
Preferences:
Hierarchy:
Superclass: Text
Class: Character
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
If true, aligns the baseline of the text to the baseline grid. |
||
readonly |
Lists all graphics contained by the Character. |
||
readonly |
Lists all page items contained by the Character. |
||
read/write |
If true, words unassociated with a hyphenation dictionary can break to the next line on any character. |
||
read/write |
The character style applied to the text. Can also accept: String. |
||
read/write |
The applied conditions. |
||
read/write |
The font applied to the Character, specified as either a font object or the name of font family. Can return: Font or String. |
||
LanguageCanalsoaccept:String |
read/write |
The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String. |
|
readonly |
The applied character styles dictated by nested styles. |
||
read/write |
The list to be part of. Can return: NumberingList or String. |
||
read/write |
The paragraph style applied to the text. Can also accept: String. |
||
readonly |
The maximum ascent of any character in the text. |
||
readonly |
The XML elements associated with the Character. |
||
Number (range 0 - 500) |
read/write |
The percent of the type size to use for auto leading. (Range: 0 to 500). |
|
read/write |
The number of half-width characters at or below which the characters automatically run horizontally in vertical text. |
||
read/write |
If true, auto tcy includes Roman characters. |
||
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 or BalanceLinesStyle enumerator. |
||
readonly |
The vertical offset of the text. |
||
read/write |
The baseline shift applied to the text. |
||
readonly |
Bullet character. |
||
read/write |
The alignment of the bullet character. |
||
read/write |
List type for bullets and numbering. |
||
read/write |
The character style to be used for the text after string. Can return: CharacterStyle or String. |
||
read/write |
The text after string expression for bullets. |
||
read/write |
If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect. |
||
readonly |
A collection of buttons. |
||
read/write |
The capitalization scheme. |
||
read/write |
The alignment of small characters to the largest character in the line. |
||
read/write |
The direction of the character. |
||
read/write |
The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise. |
||
readonly |
A collection of characters. |
||
readonly |
A collection of checkboxes. |
||
read/write |
If true, uses grid tracking to track non-Roman characters in CJK grids. |
||
readonly |
A collection of comboboxes. |
||
read/write |
The text composer to use to compose the text. |
||
read/write |
The contents of the text. Can return: String or SpecialCharacters enumerator. |
||
readonly |
The maximum descent of any character in the text. |
||
read/write |
Value of Design Axes |
||
Number (range 50 - 200) |
read/write |
The desired width (as a percentage) of individual characters. (Range: 50 to 200) |
|
read/write |
The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) |
||
Number (range 0 - 1000) |
read/write |
The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000) |
|
read/write |
Position of diacriticical characters. |
||
read/write |
The digits type. |
||
Number (range 0 - 150) |
read/write |
The number of characters to drop cap. |
|
Number (range 0 - 25) |
read/write |
The number of lines to drop cap. |
|
read/write |
The character style to apply to the drop cap. Can also accept: String. |
||
read/write |
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. |
||
readonly |
Vertical offset of the end of the text. |
||
readonly |
Horizontal offset of the end of the text. |
||
read/write |
The stroke join type applied to the characters of the text. |
||
readonly |
A collection of endnote text ranges. |
||
readonly |
A collection of endnote text frames. |
||
readonly |
EPSTexts |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Character. . Can also accept: String. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the fill color of the Character. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
|
read/write |
The amount to indent the first line. |
||
read/write |
The name of the font style. |
||
readonly |
A collection of footnotes. |
||
readonly |
A collection of form fields. |
||
read/write |
The glyph variant to substitute for standard glyphs. |
||
read/write |
The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180) |
||
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. |
||
read/write |
The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. |
||
read/write |
The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180) |
||
read/write |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. |
||
read/write |
The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. |
||
readonly |
A collection of graphic lines. |
||
read/write |
If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid. |
||
read/write |
The alignment to the frame grid or baseline grid. |
||
read/write |
The manual gyoudori setting. |
||
readonly |
A collection of groups. |
||
readonly |
A collection of hidden text objects. |
||
readonly |
The horizontal offset of the text. |
||
read/write |
The horizontal scaling applied to the Character. |
||
Number (range 0 - 10) |
read/write |
The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100) |
|
read/write |
If true, allows the last word in a text column to be hyphenated. |
||
Number (range 1 - 15) |
read/write |
The mininum number of letters at the beginning of a word that can be broken by a hyphen. |
|
Number (range 1 - 15) |
read/write |
The minimum number of letters at the end of a word that can be broken by a hyphen. |
|
read/write |
If true, allows hyphenation of capitalized words. |
||
Number (range 0 - 25) |
read/write |
The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero. |
|
read/write |
If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. |
||
Number (range 3 - 25) |
read/write |
The minimum number of letters a word must have in order to qualify for hyphenation. |
|
read/write |
If true, allows hyphenation. |
||
read/write |
The amount of white space allowed at the end of a line of non-justified text before hypenation begins. Note: Valid when composer is single-line composer. |
||
read/write |
If true, ignores optical edge alignment for the paragraph. |
||
readonly |
The index of the text in the collection or parent object. |
||
readonly |
A collection of insertion points. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
The number of grid squares in which to arrange the text. |
||
read/write |
The paragraph alignment. |
||
read/write |
Use of Kashidas for justification |
||
read/write |
If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. |
||
Number (range 1 - 50) |
read/write |
The minimum number of lines to keep together in a paragraph before allowing a page break. |
|
Number (range 1 - 50) |
read/write |
The minimum number of lines to keep together in a paragraph after a page break. |
|
read/write |
If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. |
||
read/write |
If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. |
||
Number (range 0 - 5) |
read/write |
The minimum number of lines to keep with the next paragraph. |
|
read/write |
If the first line in the paragraph should be kept with the last line of previous paragraph. |
||
read/write |
The alignment of kenten characters relative to the parent characters. |
||
read/write |
The character set used for the custom kenten character. Note: Valid only when kenten kind is custom. |
||
read/write |
The character used for kenten. Note: Valid only when kenten kind is custom. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String. |
||
read/write |
The font to use for kenten characters. Can return: Font or String. |
||
read/write |
The size (in points) of kenten characters. |
||
read/write |
The font style of kenten characters. Can return: String or NothingEnum enumerator. |
||
read/write |
The style of kenten characters. |
||
read/write |
The method of overprinting the kenten fill. |
||
read/write |
The method of overprinting the kenten stroke. |
||
read/write |
The distance between kenten characters and their parent characters. |
||
read/write |
The kenten position relative to the parent character. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String. |
||
Number (range 0 - 100) |
read/write |
The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) |
|
Number (range 0 - 100) |
read/write |
The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) |
|
read/write |
The stroke weight (in points) of kenten characters. |
||
read/write |
The horizontal size of kenten characters as a percent of the original size. |
||
read/write |
The vertical size of kenten charachers as a percent of the original size. |
||
read/write |
The type of pair kerning. |
||
read/write |
The amount of space to add or remove between characters, specified in thousands of an em. |
||
read/write |
The keyboard direction of the character. |
||
read/write |
The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect. |
||
read/write |
The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String. |
||
read/write |
The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined. |
||
read/write |
The amount to indent the last line in the paragraph. |
||
Unit |
read/write |
The leading applied to the text. Can return: Unit or Leading enumerator. |
|
read/write |
The amount of space before each character. |
||
read/write |
The point from which leading is measured from line to line. |
||
read/write |
The width of the left indent. |
||
readonly |
The number of objects in the collection. |
||
read/write |
If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. |
||
readonly |
A collection of lines. |
||
readonly |
A collection of listboxes. |
||
Number (range 50 - 200) |
read/write |
The maximum width (as a percentage) of individual characters. (Range: 50 to 200) |
|
read/write |
The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified. |
||
Number (range 0 - 1000) |
read/write |
The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000) |
|
read/write |
If true, consecutive para borders with completely similar properties are merged. |
||
Number (range 50 - 200) |
read/write |
The minimum width (as a percentage) of individual characters. (Range: 50 to 200) |
|
read/write |
The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified. |
||
Number (range 0 - 1000) |
read/write |
The minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000) |
|
Number (range 0 - 1000) |
read/write |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. |
|
read/write |
The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator. |
||
readonly |
A collection of multi-state objects. |
||
readonly |
A collection of nested GREP styles. |
||
readonly |
A collection of nested line styles. |
||
readonly |
A collection of nested styles. |
||
read/write |
If true, keeps the text on the same line. |
||
readonly |
A collection of notes. |
||
read/write |
The alignment of the number. |
||
read/write |
If true, apply the numbering restart policy. |
||
read/write |
The character style to be used for the number string. Can return: CharacterStyle or String. |
||
read/write |
Continue the numbering at this level. |
||
read/write |
The number string expression for numbering. |
||
read/write |
Numbering format options. Can return: NumberingStyle enumerator or String. |
||
read/write |
The level of the paragraph. |
||
readonly |
Numbering restart policies. |
||
read/write |
Determines starting number in a numbered list. |
||
Array of 2 Strings Array of LongIntegers |
read/write |
OpenType features. Can return: Array of Array of 2 Strings or Long Integers. |
|
read/write |
If true, uses contextual alternate forms in OpenType fonts. |
||
read/write |
If true, uses discretionary ligatures in OpenType fonts. |
||
read/write |
The figure style in OpenType fonts. |
||
read/write |
If true, uses fractions in OpenType fonts. |
||
read/write |
If true, switches hiragana fonts, which have different glyphs for horizontal and vertical. |
||
read/write |
If true, use historical forms in OpenType fonts. |
||
read/write |
If true, use alternate justification forms in OpenType fonts |
||
read/write |
If true, uses localized forms in OpenType fonts. |
||
read/write |
If true, uses mark positioning in OpenType fonts. |
||
read/write |
If true, uses ordinals in OpenType fonts. |
||
read/write |
If true, use overlapping swash forms in OpenType fonts |
||
read/write |
If true, kerns according to proportional CJK metrics in OpenType fonts. |
||
read/write |
If true, applies italics to half-width alphanumerics. |
||
read/write |
If true, use a slashed zeroes in OpenType fonts. |
||
read/write |
If true, use stretched alternate forms in OpenType fonts |
||
read/write |
If true, use stylistic alternate forms in OpenType fonts |
||
read/write |
The stylistic sets to use in OpenType fonts. |
||
read/write |
If true, uses swash forms in OpenType fonts. |
||
read/write |
If true, uses titling forms in OpenType fonts. |
||
readonly |
A collection of ellipses. |
||
read/write |
If true, the fill color of the characters will overprint. |
||
read/write |
If true, the stroke of the characters will overprint. |
||
readonly |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
||
read/write |
The shape to apply to the bottom left corner of rectangular shapes. |
||
read/write |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
||
read/write |
The bottom line weight of the border of paragraph. |
||
read/write |
The distance to offset the bottom edge of the paragraph border. |
||
read/write |
The basis (descent or baseline) used to calculate the bottom origin of the paragraph border. |
||
read/write |
The shape to apply to the bottom right corner of rectangular shapes. |
||
read/write |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph stroke. Can return: Swatch or String. |
||
read/write |
If true, then paragraph border is also displayed at the points where the paragraph splits across frames or columns. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph border gap. Note: Valid only when the border type is not solid. Can return: Swatch or String. |
||
read/write |
If true, the paragraph border gap will overprint. Note: Valid only when border type is not solid. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the paragraph border gap. Note: Valid only when the border type is not solid. (Range: 0 to 100) |
|
read/write |
The left line weight of the border of paragraph. |
||
read/write |
The distance to offset the left edge of the paragraph border. |
||
read/write |
If true, the paragraph border is on. |
||
read/write |
If true, the paragraph border will overprint. |
||
read/write |
The right line weight of the border of paragraph. |
||
read/write |
The distance to offset the right edge of the paragraph border. |
||
read/write |
The end shape of an open path. |
||
read/write |
The corner join applied to the Character. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) |
|
read/write |
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. |
||
read/write |
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 |
||
read/write |
The top line weight of the border of paragraph. |
||
read/write |
The distance to offset the top edge of the paragraph border. |
||
read/write |
The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph border. |
||
read/write |
The shape to apply to the top right corner of rectangular shapes |
||
read/write |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
||
read/write |
The type of the border for the paragraph. Can return: StrokeStyle or String. |
||
read/write |
The basis (text width or column width) used to calculate the width of the paragraph border. |
||
read/write |
Paragraph direction. |
||
read/write |
If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph. |
||
read/write |
Paragraph justification. |
||
read/write |
Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long |
||
read/write |
The shape to apply to the bottom left corner of rectangular shapes. |
||
read/write |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
||
read/write |
The distance to offset the bottom edge of the paragraph. |
||
read/write |
The basis (descent or baseline) used to calculate the bottom origin of the paragraph shading. |
||
read/write |
The shape to apply to the bottom right corner of rectangular shapes. |
||
read/write |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
||
read/write |
If true, forces the shading of the paragraph to be clipped with respect to frame shape. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph shading. Can return: Swatch or String. |
||
read/write |
The distance to offset the left edge of the paragraph. |
||
read/write |
If true, the paragraph shading is On. |
||
read/write |
If true, the paragraph shading will overprint. |
||
read/write |
The distance to offset the right edge of the paragraph. |
||
read/write |
If true, suppress printing of the shading of the paragraph. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) |
|
read/write |
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. |
||
read/write |
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 |
||
read/write |
The distance to offset the top edge of the paragraph. |
||
read/write |
The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph shading. |
||
read/write |
The shape to apply to the top right corner of rectangular shapes |
||
read/write |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
||
read/write |
The basis (text width or column width) used to calculate the width of the paragraph shading. |
||
readonly |
A collection of paragraphs. |
||
readonly |
The parent of the Character (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, Footnote, Note, Change or HiddenText). |
||
readonly |
The story that contains the text. |
||
Array of TextFrames |
readonly |
An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths. |
|
read/write |
The text size. |
||
readonly |
A collection of polygons. |
||
read/write |
The text position relative to the baseline. |
||
read/write |
The OpenType positional form. |
||
readonly |
A collection of preferences objects. |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
The hyphenation style chosen for the provider. |
||
readonly |
A collection of radio buttons. |
||
readonly |
A collection of rectangles. |
||
read/write |
If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers. |
||
read/write |
The width of the right indent. |
||
read/write |
If true, rotates Roman characters in vertical text. |
||
read/write |
The ruby alignment. |
||
read/write |
If true, auto aligns ruby. |
||
read/write |
If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent. |
||
read/write |
If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. |
||
read/write |
The number of digits included in auto tcy (tate-chuu-yoko) in ruby. |
||
read/write |
If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String. |
||
read/write |
If true, ruby is on. |
||
read/write |
The font applied to ruby characters. Can return: Font or String. |
||
read/write |
The size (in points) of ruby characters. |
||
read/write |
The font style of ruby characters. Can return: String or NothingEnum enumerator. |
||
read/write |
If true, uses OpenType Pro fonts for ruby. |
||
read/write |
If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount. |
||
read/write |
The method of overprinting the ruby fill. |
||
read/write |
The method of overprinting the ruby stroke. |
||
read/write |
The amount by which ruby characters can overhang the parent text. |
||
read/write |
The amount (as a percentage) to scale the parent text size to determine the ruby text size. |
||
read/write |
The ruby spacing relative to the parent text. |
||
read/write |
The position of ruby characters relative to the parent text. |
||
read/write |
The ruby string contents. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String. |
||
read/write |
The stroke tint (as a percentage) of ruby characters. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) |
|
read/write |
The ruby type. |
||
read/write |
The stroke weight (in points) of ruby characters. |
||
read/write |
The amount of horizontal space between ruby and parent characters. |
||
read/write |
The horizontal size of ruby characters, specified as a percent of the original size. |
||
read/write |
The amount of vertical space between ruby and parent characters. |
||
read/write |
The vertical size of ruby characters, specified as a percent of the original size. |
||
read/write |
If true, places a rule above the paragraph. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String. |
||
read/write |
If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid. |
|
read/write |
The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph. |
||
read/write |
The line weight of the rule above. |
||
read/write |
The amount to offset the paragraph rule above from the baseline of the first line the paragraph. |
||
read/write |
If true, the paragraph rule above will overprint. |
||
read/write |
The distance to indent the right edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) |
|
read/write |
The stroke type of the rule above the paragraph. Can return: StrokeStyle or String. |
||
read/write |
The basis (text width or column width) used to calculate the width of the paragraph rule above. |
||
read/write |
If true, applies a paragraph rule below. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String. |
||
read/write |
If true, the gap color of the rule below will overprint. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid. |
|
read/write |
The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph. |
||
read/write |
The line weight of the rule below. |
||
read/write |
The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. |
||
read/write |
If true, the rule below will overprint. |
||
read/write |
The distance to indent the right edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) |
|
read/write |
The stroke type of the rule below the paragraph. Can return: StrokeStyle or String. |
||
read/write |
The basis (text width or column width) used to calculate the width of the paragraph rule below. |
||
Unit |
read/write |
The space between paragraphs using same style. Can return: Unit or Spacing enumerator. |
|
read/write |
If true, the line changes size when characters are scaled. |
||
read/write |
If true, applies shatai rotation. |
||
read/write |
If true, adjusts shatai tsume. |
||
read/write |
The shatai lens angle (in degrees). |
||
read/write |
The amount (as a percentage) of shatai obliquing to apply. |
||
readonly |
A collection of signature fields. |
||
read/write |
The alignment to use for lines that contain a single word. |
||
read/write |
The skew angle of the Character. |
||
read/write |
The height of the paragraph space below. |
||
read/write |
The height of the paragraph space above. |
||
read/write |
The minimum space after a span or a split column |
||
read/write |
The minimum space before a span or a split column |
||
read/write |
Whether a paragraph should be a single column, span columns or split columns |
||
ShortInteger(1-40) |
read/write |
The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. |
|
readonly |
The spline items collection. |
||
read/write |
The inside gutter if the paragraph splits columns |
||
read/write |
The outside gutter if the paragraph splits columns |
||
read/write |
The location at which to start the paragraph. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String. |
||
read/write |
If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. |
||
Number (range 0 - 100) |
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. |
|
read/write |
The amount by which to offset the strikethrough stroke from the text baseline. |
||
read/write |
If true, the strikethrough stroke will overprint. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) |
|
read/write |
The stroke type of the strikethrough stroke. Can return: StrokeStyle or String. |
||
read/write |
The stroke weight of the strikethrough stroke. |
||
read/write |
If true, draws a strikethrough line through the text. |
||
read/write |
The stroke alignment applied to the text. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Character. Can also accept: String. |
||
Number (range 0 - 100) |
read/write |
The tint (as a percentage) of the stroke color of the Character. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
|
read/write |
The stroke weight applied to the characters of the text. |
||
readonly |
If true, the applied style has been overridden with additional attributes. |
||
Array of Arrays of Property Name/Value Pairs. |
read/write |
A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs. |
|
readonly |
A collection of tab stops. |
||
readonly |
A collection of tables. |
||
read/write |
If true, makes the character horizontal in vertical text. |
||
read/write |
The horizontal offset for horizontal characters in vertical text. |
||
read/write |
The vertical offset for horizontal characters in vertical text. |
||
readonly |
A collection of text boxes. |
||
readonly |
A collection of text columns. |
||
readonly |
A collection of text frames. |
||
readonly |
A collection of text style ranges. |
||
readonly |
A collection of text variable instances. |
||
readonly |
A collection of text objects. |
||
read/write |
The amount by which to loosen or tighten a block of text, specified in thousands of an em. |
||
read/write |
The amount of space after each character. |
||
read/write |
If true, ideographic spaces will not wrap to the next line like text characters. |
||
read/write |
The amount of horizontal character compression. |
||
read/write |
If true, underlines the text. |
||
read/write |
The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String. |
||
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 or String. |
||
read/write |
If true, the gap color of the underline stroke will overprint. |
||
Number (range 0 - 100) |
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. |
|
read/write |
The amount by which to offset the underline from the text baseline. |
||
read/write |
If true, the underline stroke color will overprint. |
||
Number (range 0 - 100) |
read/write |
The underline stroke tint (as a percentage). (Range: 0 to 100) |
|
read/write |
The stroke type of the underline stroke. Can return: StrokeStyle or String. |
||
read/write |
The stroke weight of the underline stroke. |
||
read/write |
The vertical scaling applied to the Character. |
||
read/write |
If true, turns on warichu. |
||
read/write |
The warichu alignment. |
||
read/write |
The minimum number of characters allowed after a line break. |
||
read/write |
The minimum number of characters allowed before a line break. |
||
read/write |
The gap between lines of warichu characters. |
||
read/write |
The number of lines of warichu within a single normal line. |
||
read/write |
The amount (as a percentage) to scale parent text size to determine warichu size. |
||
readonly |
A collection of words. |
||
read/write |
The x (horizontal) offset for diacritic adjustment. |
||
read/write |
The y (vertical) offset for diacritic adjustment. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined applyCharacterStyle (using:CharacterStyle)
Apply a character style.
Parameter |
Type |
Description |
---|---|---|
using |
The character style to apply. |
undefined applyConditions (using:Array of Condition, [removeExisting:Boolean=Boolean])
Apply one or more conditions.
Parameter |
Type |
Description |
---|---|---|
using |
The condition(s) to apply |
|
removeExisting |
If true, remove existing conditions. (Optional) (default: false) |
undefined applyParagraphStyle (using:ParagraphStyle, [clearingOverrides:Boolean=Boolean])
Apply a paragraph style.
Parameter |
Type |
Description |
---|---|---|
using |
The paragraph style to apply. |
|
clearingOverrides |
If true, clear any text attributes before applying the style. (Optional) (default: true) |
BackgroundTask asynchronousExportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])
asynchronously exports the object(s) to a file.
Parameter |
Type |
Description |
---|---|---|
format |
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
|
to |
The path to the export file. |
|
showingOptions |
If true, displays the export options dialog. (Optional) (default: false) |
|
using |
The export style. (Optional) |
|
versionComments |
The comment for this version. (Optional) |
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
Text changeGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeGrep (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeText (reverseOrder:Boolean)
Finds text that matches the find what value and replaces the text with the change to value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text changeTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
undefined changecase (using:ChangecaseMode)
Sets the case of the text.
Parameter |
Type |
Description |
---|---|---|
using |
The text case option. |
undefined clearOverrides ([overridesToClear:OverrideType=OverrideType])
Clears the specified types of override.
Parameter |
Type |
Description |
---|---|---|
overridesToClear |
The types of override to clear. (Optional) (default: OverrideType.ALL) |
undefined convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.
Note convertToNote ()
Converts the text to a note.
Table convertToTable (columnSeparator:String, rowSeparator:String, [numberOfColumns:Number=Number])
Converts the text to a table.
Parameter |
Type |
Description |
---|---|---|
columnSeparator |
The character that starts a new column in the new table. (Optional) |
|
rowSeparator |
The character starts a new row in the new table. (Optional) |
|
numberOfColumns |
The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) (default: 1) |
undefined createEmailQRCode (emailAddress:String, subject:String, body:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Email QR Code on the page item or document
Parameter |
Type |
Description |
---|---|---|
emailAddress |
QR code Email Address (Optional) |
|
subject |
QR code Email Subject (Optional) |
|
body |
QR code Email Body Message (Optional) |
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
withProperties |
Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) |
undefined createHyperlinkQRCode (urlLink:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Hyperlink QR Code on the page item or document
Parameter |
Type |
Description |
---|---|---|
urlLink |
QR code Hyperlink URL (Optional) |
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
withProperties |
Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) |
PageItem createOutlines ([deleteOriginal:Boolean=Boolean])
Converts text to outlines. Each line of text becomes a polygon object. When the converted text is a single letter that has no internal spaces or detached parts, the polygon contains only a single path. Note: To determine whether a font allows the creation of outlines, see allow outlines.
Parameter |
Type |
Description |
---|---|---|
deleteOriginal |
If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true) |
undefined createPlainTextQRCode (plainText:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Plain Text QR Code on the page item
Parameter |
Type |
Description |
---|---|---|
plainText |
QR code Plain Text (Optional) |
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
withProperties |
Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) |
Boolean createStyleThumbnailWithProperties (previewText:String, pointSize:Number, space:ColorSpace, colorValue:Array of Number, to:File, charOrParaStyle:StyleType)
Create thumbnail for selected text using the applied style and overrides with the given properties.
Parameter |
Type |
Description |
---|---|---|
previewText |
Text to use as sample |
|
pointSize |
Text font size (in points) |
|
space |
Color space RGB, CMYK or LAB |
|
colorValue |
Color values |
|
to |
The path to the export file. |
|
charOrParaStyle |
The applied style type to use. |
undefined createTextMsgQRCode (cellNumber:String, textMessage:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Text Msg QR Code on the page item or document
Parameter |
Type |
Description |
---|---|---|
cellNumber |
QR code Text Phone Number (Optional) |
|
textMessage |
QR code Text Message (Optional) |
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
withProperties |
Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) |
Boolean createThumbnailWithProperties (previewText:String, pointSize:Number, space:ColorSpace, colorValue:Array of Number, to:File)
Create thumbnail for selected text with the given properties.
Parameter |
Type |
Description |
---|---|---|
previewText |
Text to use as sample |
|
pointSize |
Text font size (in points) |
|
space |
Color space RGB, CMYK or LAB |
|
colorValue |
Color values |
|
to |
The path to the export file. |
undefined createVCardQRCode (firstName:String, lastName:String, jobTitle:String, cellPhone:String, phone:String, email:String, organisation:String, streetAddress:String, city:String, adrState:String, country:String, postalCode:String, website:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)
Create Business Card QR Code on the page item or load on document's placegun
Parameter |
Type |
Description |
---|---|---|
firstName |
QR code Business Card First Name (Optional) |
|
lastName |
QR code Business Card Last Name (Optional) |
|
jobTitle |
QR code Business Card Title (Optional) |
|
cellPhone |
QR code Business Card Cell Phone Number (Optional) |
|
phone |
QR code Business Card Phone Number (Optional) |
|
|
QR code Business Card Email Address (Optional) |
|
organisation |
QR code Business Card Organisation (Optional) |
|
streetAddress |
QR code Business Card Street Address (Optional) |
|
city |
QR code Business Card City (Optional) |
|
adrState |
QR code Business Card State (Optional) |
|
country |
QR code Business Card Country (Optional) |
|
postalCode |
QR code Business Card Postal Code (Optional) |
|
website |
QR code Business Card URL (Optional) |
|
qrCodeSwatch |
Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) |
|
withProperties |
Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) |
Text duplicate (to:LocationOptions, reference:Varies Cell Column Row Story Table Text PageItem)
Duplicates the text in the specified location.
Parameter |
Type |
Description |
---|---|---|
to |
The location relative to the reference object or within the containing object. |
|
reference |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) |
undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])
Exports the object(s) to a file.
Parameter |
Type |
Description |
---|---|---|
format |
The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
|
to |
The path to the export file. |
|
showingOptions |
If true, displays the export options dialog. (Optional) (default: false) |
|
using |
The export style. (Optional) |
|
versionComments |
The comment for this version. (Optional) |
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
Text findGlyph (reverseOrder:Boolean)
Finds glyphs that match the find what value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findGrep (reverseOrder:Boolean)
Finds text that matches the find what value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
HyperlinkTextSource findHyperlinks (sortOrder:RangeSortOrder)
Finds hyperlink sources that intersecting with specified text range.
Parameter |
Type |
Description |
---|---|---|
sortOrder |
The sort order of found ranges. (Optional) |
Text findText (reverseOrder:Boolean)
Finds text that matches the find what value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Text findTransliterate (reverseOrder:Boolean)
Finds text that matches the find character type value.
Parameter |
Type |
Description |
---|---|---|
reverseOrder |
If true, returns the results in reverse order. (Optional) |
Character getElements ()
Resolves the object specifier, creating an array of object references.
Boolean isNthDesignAxisHidden (nthAxisIndex:Number)
If true, Nth design axis of variable font is hidden.
Parameter |
Type |
Description |
---|---|---|
nthAxisIndex |
Index of design axis. |
undefined markup (using:XMLElement)
Associates the page item with the specified XML element while preserving existing content.
Parameter |
Type |
Description |
---|---|---|
using |
The XML element. |
Text move (to:LocationOptions, reference:Varies Cell Column Row Story Table Text PageItem)
Moves the text to the specified location.
Parameter |
Type |
Description |
---|---|---|
to |
The location relative to the reference object or within the containing object. |
|
reference |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) |
Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)
Places the file.
Parameter |
Type |
Description |
---|---|---|
fileName |
The file to place |
|
showingOptions |
Whether to display the import options dialog (Optional) (default: false) |
|
withProperties |
Initial values for properties of the placed object(s) (Optional) |
undefined recompose ()
Recomposes the text in the Character.
undefined remove ()
Deletes the Character.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
Parameter |
Type |
Description |
---|---|---|
existingSelection |
The selection status of the Character in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
undefined setNthDesignAxis (nthAxisIndex:Number, nthAxisValue:Number)
Set Nth design axis of a variable font.
Parameter |
Type |
Description |
---|---|---|
nthAxisIndex |
Index of design axis. |
|
nthAxisValue |
Value of nth design axis. |
undefined showText ()
Jump to the text range.
Boolean textHasOverrides (charOrParaStyle:StyleType, [charStyleAsOverride:Boolean=Boolean])
If true, text has local overrides
Parameter |
Type |
Description |
---|---|---|
charOrParaStyle |
Style type to look at. |
|
charStyleAsOverride |
Whether to consider character styles as overrides or not (Optional) (default: true) |
String toSource ()
Generates a string which, if executed, will return the Character.
String toSpecifier ()
Retrieves the object specifier.
Object of
Bullet.parent
Button.parent
Character.parent
CheckBox.parent
ComboBox.parent
EPSText.parent
EndnoteRange.parent
Event.parent
EventListener.parent
FormField.parent
GraphicLine.parent
Group.parent
InsertionPoint.parent
Line.parent
ListBox.parent
MultiStateObject.parent
MutationEvent.parent
NestedGrepStyle.parent
NestedLineStyle.parent
NestedStyle.parent
NumberingRestartPolicy.parent
Oval.parent
PageItem.parent
Paragraph.parent
Polygon.parent
Preference.parent
RadioButton.parent
Rectangle.parent
SignatureField.parent
SplineItem.parent
TabStop.parent
Table.parent
Text.parent
TextBox.parent
TextColumn.parent
TextFrame.parent
TextStyleRange.parent
Word.parent
Return
Characters.[]()