Adobe InDesign CS6 (8.0) Object Model JS: Character

InDesign CS6

Class

Character

 A text character. Base Class: Text

QuickLinks

addEventListener, applyCharacterStyle, applyConditions, applyParagraphStyle, asynchronousExportFile, autoTag, changeGlyph, changeGrep, changeText, changeTransliterate, changecase, clearOverrides, convertBulletsAndNumberingToText, convertToNote, convertToTable, createOutlines, duplicate, exportFile, findGlyph, findGrep, findHyperlinks, findText, findTransliterate, getElements, markup, move, place, recompose, remove, removeEventListener, select, showText, toSource, toSpecifier

Hierarchy

Cell | Change | Character | Footnote | HiddenText | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | XmlStory
Text
Character
Bullet | Button | Character | CheckBox | ComboBox | EPSText | Event | EventListener | FormField | GraphicLine | Group | InsertionPoint | Line | ListBox | MultiStateObject | MutationEvent | NestedGrepStyle | NestedLineStyle | NestedStyle | NumberingRestartPolicy | Oval | PageItem | Paragraph | Polygon | Preference | RadioButton | Rectangle | SignatureField | SplineItem | TabStop | Table | Text | TextBox | TextColumn | TextFrame | TextStyleRange | Word

Properties

PropertyTypeAccessDescription
alignToBaselinebool r/wIf true, aligns the baseline of the text to the baseline grid.
allGraphicsArray of Graphic readonlyLists all graphics contained by the Character.
allPageItemsArray of PageItem readonlyLists all page items contained by the Character.
allowArbitraryHyphenationbool r/wIf true, words unassociated with a hyphenation dictionary can break to the next line on any character.
appliedCharacterStyleCharacterStyleString r/wThe character style applied to the text. Can also accept: String.
appliedConditionsArray of Condition r/wThe applied conditions.
appliedFontFont
String
r/wThe font applied to the Character, specified as either a font object or the name of font family. Can return: Font or String.
appliedLanguageLanguage
LanguageWithVendors
String
r/wThe language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
appliedNestedStylesArray of CharacterStyle readonlyThe applied character styles dictated by nested styles.
appliedNumberingListNumberingList
String
r/wThe list to be part of. Can return: NumberingList or String.
appliedParagraphStyleParagraphStyle
String
r/wThe paragraph style applied to the text. Can also accept: String.
ascentMeasurement Unit (Number or String) readonlyThe maximum ascent of any character in the text.
associatedXMLElementsArray of XMLItem readonlyThe XML elements associated with the Character.
autoLeadingnumber r/wThe percent of the type size to use for auto leading. (Range: 0 to 500).
autoTcynumber r/wThe number of half-width characters at or below which the characters automatically run horizontally in vertical text.
autoTcyIncludeRomanbool r/wIf true, auto tcy includes Roman characters.
balanceRaggedLinesBalanceLinesStyle
Boolean
r/wIf 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.
baselineMeasurement Unit (Number or String) readonlyThe vertical offset of the text.
baselineShiftMeasurement Unit (Number or String) r/wThe baseline shift applied to the text.
bulletCharBullet readonlyBullet character.
bulletsAlignmentListAlignment:
ListAlignment.LEFT_ALIGN
ListAlignment.CENTER_ALIGN
ListAlignment.RIGHT_ALIGN
r/wThe alignment of the bullet character.
bulletsAndNumberingListTypeListType:
ListType.NO_LIST
ListType.BULLET_LIST
ListType.NUMBERED_LIST
r/wList type for bullets and numbering.
bulletsCharacterStyleCharacterStyle
String
r/wThe character style to be used for the text after string. Can return: CharacterStyle or String.
bulletsTextAfterstring r/wThe text after string expression for bullets.
bunriKinshibool r/wIf true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect.
buttonsButtons readonlyA collection of buttons.
capitalizationCapitalization:
Capitalization.NORMAL
Capitalization.SMALL_CAPS
Capitalization.ALL_CAPS
Capitalization.CAP_TO_SMALL_CAP
r/wThe capitalization scheme.
characterAlignmentCharacterAlignment:
CharacterAlignment.ALIGN_BASELINE
CharacterAlignment.ALIGN_EM_TOP
CharacterAlignment.ALIGN_EM_CENTER
CharacterAlignment.ALIGN_EM_BOTTOM
CharacterAlignment.ALIGN_ICF_TOP
CharacterAlignment.ALIGN_ICF_BOTTOM
r/wThe alignment of small characters to the largest character in the line.
characterDirectionCharacterDirectionOptions:
CharacterDirectionOptions.DEFAULT_DIRECTION
CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION
CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe direction of the character.
characterRotationnumber r/wThe rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise.
charactersCharacters readonlyA collection of characters.
checkBoxesCheckBoxes readonlyA collection of checkboxes.
cjkGridTrackingbool r/wIf true, uses grid tracking to track non-Roman characters in CJK grids.
comboBoxesComboBoxes readonlyA collection of comboboxes.
composerstring r/wThe text composer to use to compose the text.
contentsSpecialCharacters
String
r/wThe contents of the text. Can return: String or SpecialCharacters enumerator.
descentMeasurement Unit (Number or String) readonlyThe maximum descent of any character in the text.
desiredGlyphScalingnumber r/wThe desired width (as a percentage) of individual characters. (Range: 50 to 200)
desiredLetterSpacingnumber r/wThe desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
desiredWordSpacingnumber r/wThe desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
diacriticPositionDiacriticPositionOptions:
DiacriticPositionOptions.DEFAULT_POSITION
DiacriticPositionOptions.LOOSE_POSITION
DiacriticPositionOptions.MEDIUM_POSITION
DiacriticPositionOptions.TIGHT_POSITION
DiacriticPositionOptions.OPENTYPE_POSITION
DiacriticPositionOptions.OPENTYPE_POSITION_FROM_BASELINE
r/wPosition of diacriticical characters.
digitsTypeDigitsTypeOptions:
DigitsTypeOptions.DEFAULT_DIGITS
DigitsTypeOptions.ARABIC_DIGITS
DigitsTypeOptions.HINDI_DIGITS
DigitsTypeOptions.FARSI_DIGITS
DigitsTypeOptions.NATIVE_DIGITS
DigitsTypeOptions.FULL_FARSI_DIGITS
DigitsTypeOptions.THAI_DIGITS
DigitsTypeOptions.LAO_DIGITS
DigitsTypeOptions.DEVANAGARI_DIGITS
DigitsTypeOptions.BENGALI_DIGITS
DigitsTypeOptions.GURMUKHI_DIGITS
DigitsTypeOptions.GUJARATI_DIGITS
DigitsTypeOptions.ORIYA_DIGITS
DigitsTypeOptions.TAMIL_DIGITS
DigitsTypeOptions.TELUGU_DIGITS
DigitsTypeOptions.KANNADA_DIGITS
DigitsTypeOptions.MALAYALAM_DIGITS
DigitsTypeOptions.TIBETAN_DIGITS
DigitsTypeOptions.KHMER_DIGITS
DigitsTypeOptions.BURMESE_DIGITS
r/wThe digits type.
dropCapCharactersnumber (range: 0 - 150) r/wThe number of characters to drop cap.
dropCapLinesnumber (range: 0 - 25) r/wThe number of lines to drop cap.
dropCapStyleCharacterStyle
String
r/wThe character style to apply to the drop cap. Can also accept: String.
dropcapDetailnumber 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.
endBaselineMeasurement Unit (Number or String) readonlyVertical offset of the end of the text.
endHorizontalOffsetMeasurement Unit (Number or String) readonlyHorizontal offset of the end of the text.
endJoinOutlineJoin:
OutlineJoin.MITER_END_JOIN
OutlineJoin.ROUND_END_JOIN
OutlineJoin.BEVEL_END_JOIN
r/wThe stroke join type applied to the characters of the text.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the Character. . Can also accept: String.
fillTintnumber r/wThe 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.)
firstLineIndentMeasurement Unit (Number or String) r/wThe amount to indent the first line.
fontStylestring r/wThe name of the font style.
footnotesFootnotes readonlyA collection of footnotes.
formFieldsFormFields readonlyA collection of form fields.
glyphFormAlternateGlyphForms:
AlternateGlyphForms.NONE
AlternateGlyphForms.TRADITIONAL_FORM
AlternateGlyphForms.EXPERT_FORM
AlternateGlyphForms.JIS78_FORM
AlternateGlyphForms.JIS83_FORM
AlternateGlyphForms.MONOSPACED_HALF_WIDTH_FORM
AlternateGlyphForms.THIRD_WIDTH_FORM
AlternateGlyphForms.QUARTER_WIDTH_FORM
AlternateGlyphForms.NLC_FORM
AlternateGlyphForms.PROPORTIONAL_WIDTH_FORM
AlternateGlyphForms.FULL_WIDTH_FORM
AlternateGlyphForms.JIS04_FORM
AlternateGlyphForms.JIS90_FORM
r/wThe glyph variant to substitute for standard glyphs.
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
gradientFillLengthnumber r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
gradientFillStartArray of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
gradientStrokeAnglenumber r/wThe angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
gradientStrokeLengthnumber r/wThe length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
gradientStrokeStartArray of Measurement Unit (Number or String) r/wThe starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
graphicLinesGraphicLines readonlyA collection of graphic lines.
gridAlignFirstLineOnlybool r/wIf true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
gridAlignmentGridAlignment:
GridAlignment.NONE
GridAlignment.ALIGN_BASELINE
GridAlignment.ALIGN_EM_TOP
GridAlignment.ALIGN_EM_CENTER
GridAlignment.ALIGN_EM_BOTTOM
GridAlignment.ALIGN_ICF_TOP
GridAlignment.ALIGN_ICF_BOTTOM
r/wThe alignment to the frame grid or baseline grid.
gridGyoudorinumber r/wThe manual gyoudori setting.
groupsGroups readonlyA collection of groups.
hiddenTextsHiddenTexts readonlyA collection of hidden text objects.
horizontalOffsetMeasurement Unit (Number or String) readonlyThe horizontal offset of the text.
horizontalScalenumber r/wThe horizontal scaling applied to the Character.
hyphenWeightnumber (range: 0 - 10) r/wThe relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)
hyphenateAcrossColumnsbool r/wIf true, allows the last word in a text column to be hyphenated.
hyphenateAfterFirstnumber (range: 1 - 15) r/wThe mininum number of letters at the beginning of a word that can be broken by a hyphen.
hyphenateBeforeLastnumber (range: 1 - 15) r/wThe minimum number of letters at the end of a word that can be broken by a hyphen.
hyphenateCapitalizedWordsbool r/wIf true, allows hyphenation of capitalized words.
hyphenateLadderLimitnumber (range: 0 - 25) r/wThe maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.
hyphenateLastWordbool r/wIf true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
hyphenateWordsLongerThannumber (range: 3 - 25) r/wThe minimum number of letters a word must have in order to qualify for hyphenation.
hyphenationbool r/wIf true, allows hyphenation.
hyphenationZoneMeasurement Unit (Number or String) r/wThe 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.
ignoreEdgeAlignmentbool r/wIf true, ignores optical edge alignment for the paragraph.
indexnumber readonlyThe index of the text in the collection or parent object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jidorinumber r/wThe number of grid squares in which to arrange the text.
justificationJustification:
Justification.LEFT_ALIGN
Justification.CENTER_ALIGN
Justification.RIGHT_ALIGN
Justification.LEFT_JUSTIFIED
Justification.RIGHT_JUSTIFIED
Justification.CENTER_JUSTIFIED
Justification.FULLY_JUSTIFIED
Justification.TO_BINDING_SIDE
Justification.AWAY_FROM_BINDING_SIDE
r/wThe paragraph alignment.
kashidasKashidasOptions:
KashidasOptions.DEFAULT_KASHIDAS
KashidasOptions.KASHIDAS_OFF
r/wUse of Kashidas for justification
keepAllLinesTogetherbool r/wIf true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
keepFirstLinesnumber (range: 1 - 50) r/wThe minimum number of lines to keep together in a paragraph before allowing a page break.
keepLastLinesnumber (range: 1 - 50) r/wThe minimum number of lines to keep together in a paragraph after a page break.
keepLinesTogetherbool r/wIf true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepRuleAboveInFramebool r/wIf true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.
keepWithNextnumber (range: 0 - 5) r/wThe minimum number of lines to keep with the next paragraph.
keepWithPreviousbool r/wIf the first line in the paragraph should be kept with the last line of previous paragraph.
kentenAlignmentKentenAlignment:
KentenAlignment.ALIGN_KENTEN_LEFT
KentenAlignment.ALIGN_KENTEN_CENTER
r/wThe alignment of kenten characters relative to the parent characters.
kentenCharacterSetKentenCharacterSet:
KentenCharacterSet.CHARACTER_INPUT
KentenCharacterSet.SHIFT_JIS
KentenCharacterSet.JIS
KentenCharacterSet.KUTEN
KentenCharacterSet.UNICODE
r/wThe character set used for the custom kenten character. Note: Valid only when kenten kind is custom.
kentenCustomCharacterstring r/wThe character used for kenten. Note: Valid only when kenten kind is custom.
kentenFillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String.
kentenFontFont
String
r/wThe font to use for kenten characters. Can return: Font or String.
kentenFontSizenumber r/wThe size (in points) of kenten characters.
kentenFontStyleNothingEnum
String
r/wThe font style of kenten characters. Can return: String or NothingEnum enumerator.
kentenKindKentenCharacter:
KentenCharacter.NONE
KentenCharacter.KENTEN_SESAME_DOT
KentenCharacter.KENTEN_WHITE_SESAME_DOT
KentenCharacter.KENTEN_BLACK_CIRCLE
KentenCharacter.KENTEN_WHITE_CIRCLE
KentenCharacter.KENTEN_BLACK_TRIANGLE
KentenCharacter.KENTEN_WHITE_TRIANGLE
KentenCharacter.KENTEN_BULLSEYE
KentenCharacter.KENTEN_FISHEYE
KentenCharacter.KENTEN_SMALL_BLACK_CIRCLE
KentenCharacter.KENTEN_SMALL_WHITE_CIRCLE
KentenCharacter.CUSTOM
r/wThe style of kenten characters.
kentenOverprintFillAdornmentOverprint:
AdornmentOverprint.AUTO
AdornmentOverprint.OVERPRINT_ON
AdornmentOverprint.OVERPRINT_OFF
r/wThe method of overprinting the kenten fill.
kentenOverprintStrokeAdornmentOverprint:
AdornmentOverprint.AUTO
AdornmentOverprint.OVERPRINT_ON
AdornmentOverprint.OVERPRINT_OFF
r/wThe method of overprinting the kenten stroke.
kentenPlacementnumber r/wThe distance between kenten characters and their parent characters.
kentenPositionRubyKentenPosition:
RubyKentenPosition.ABOVE_RIGHT
RubyKentenPosition.BELOW_LEFT
r/wThe kenten position relative to the parent character.
kentenStrokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String.
kentenStrokeTintnumber r/wThe stroke tint (as a percentage) of kenten characters. (Range: 0 to 100)
kentenTintnumber r/wThe fill tint (as a percentage) of kenten characters. (Range: 0 to 100)
kentenWeightnumber r/wThe stroke weight (in points) of kenten characters.
kentenXScalenumber r/wThe horizontal size of kenten characters as a percent of the original size.
kentenYScalenumber r/wThe vertical size of kenten charachers as a percent of the original size.
kerningMethodstring r/wThe type of pair kerning.
kerningValuenumber r/wThe amount of space to add or remove between characters, specified in thousands of an em.
keyboardDirectionCharacterDirectionOptions:
CharacterDirectionOptions.DEFAULT_DIRECTION
CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION
CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe keyboard direction of the character.
kinsokuHangTypeKinsokuHangTypes:
KinsokuHangTypes.NONE
KinsokuHangTypes.KINSOKU_HANG_REGULAR
KinsokuHangTypes.KINSOKU_HANG_FORCE
r/wThe type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect.
kinsokuSetKinsokuSet
KinsokuTable
String
r/wThe kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String.
kinsokuTypeKinsokuType:
KinsokuType.KINSOKU_PUSH_IN_FIRST
KinsokuType.KINSOKU_PUSH_OUT_FIRST
KinsokuType.KINSOKU_PUSH_OUT_ONLY
KinsokuType.KINSOKU_PRIORITIZE_ADJUSTMENT_AMOUNT
r/wThe type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined.
lastLineIndentMeasurement Unit (Number or String) r/wThe amount to indent the last line in the paragraph.
leadingLeading
Unit
r/wThe leading applied to the text. Can return: Unit or Leading enumerator.
leadingAkinumber r/wThe amount of space before each character.
leadingModelLeadingModel:
LeadingModel.LEADING_MODEL_ROMAN
LeadingModel.LEADING_MODEL_AKI_BELOW
LeadingModel.LEADING_MODEL_AKI_ABOVE
LeadingModel.LEADING_MODEL_CENTER
LeadingModel.LEADING_MODEL_CENTER_DOWN
r/wThe point from which leading is measured from line to line.
leftIndentMeasurement Unit (Number or String) r/wThe width of the left indent.
lengthnumber readonlyThe number of objects in the collection.
ligaturesbool r/wIf true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
linesLines readonlyA collection of lines.
listBoxesListBoxes readonlyA collection of listboxes.
maximumGlyphScalingnumber r/wThe maximum width (as a percentage) of individual characters. (Range: 50 to 200)
maximumLetterSpacingnumber r/wThe 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.
maximumWordSpacingnumber r/wThe maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
minimumGlyphScalingnumber r/wThe minimum width (as a percentage) of individual characters. (Range: 50 to 200)
minimumLetterSpacingnumber r/wThe 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.
minimumWordSpacingnumber r/wThe minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
miterLimitnumber (range: 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. (default: 4)
mojikumiMojikumiTable
MojikumiTableDefaults
String
r/wThe mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator.
multiStateObjectsMultiStateObjects readonlyA collection of multi-state objects.
nestedGrepStylesNestedGrepStyles readonlyA collection of nested GREP styles.
nestedLineStylesNestedLineStyles readonlyA collection of nested line styles.
nestedStylesNestedStyles readonlyA collection of nested styles.
noBreakbool r/wIf true, keeps the text on the same line.
notesNotes readonlyA collection of notes.
numberingAlignmentListAlignment:
ListAlignment.LEFT_ALIGN
ListAlignment.CENTER_ALIGN
ListAlignment.RIGHT_ALIGN
r/wThe alignment of the number.
numberingApplyRestartPolicybool r/wIf true, apply the numbering restart policy.
numberingCharacterStyleCharacterStyle
String
r/wThe character style to be used for the number string. Can return: CharacterStyle or String.
numberingContinuebool r/wContinue the numbering at this level.
numberingExpressionstring r/wThe number string expression for numbering.
numberingFormatNumberingStyle
String
r/wNumbering format options. Can return: NumberingStyle enumerator or String.
numberingLevelnumber r/wThe level of the paragraph.
numberingRestartPoliciesNumberingRestartPolicy readonlyNumbering restart policies.
numberingStartAtnumber r/wDetermines starting number in a numbered list.
opentypeFeaturesArray of
Array of 2 Strings
Long Integers
r/wOpenType features. Can return: Array of Array of 2 Strings or Long Integers.
otfContextualAlternatebool r/wIf true, uses contextual alternate forms in OpenType fonts.
otfDiscretionaryLigaturebool r/wIf true, uses discretionary ligatures in OpenType fonts.
otfFigureStyleOTFFigureStyle:
OTFFigureStyle.TABULAR_LINING
OTFFigureStyle.PROPORTIONAL_OLDSTYLE
OTFFigureStyle.PROPORTIONAL_LINING
OTFFigureStyle.TABULAR_OLDSTYLE
OTFFigureStyle.DEFAULT_VALUE
r/wThe figure style in OpenType fonts.
otfFractionbool r/wIf true, uses fractions in OpenType fonts.
otfHVKanabool r/wIf true, switches hiragana fonts, which have different glyphs for horizontal and vertical.
otfHistoricalbool r/wIf true, use historical forms in OpenType fonts.
otfJustificationAlternatebool r/wIf true, use alternate justification forms in OpenType fonts
otfLocalebool r/wIf true, uses localized forms in OpenType fonts.
otfMarkbool r/wIf true, uses mark positioning in OpenType fonts.
otfOrdinalbool r/wIf true, uses ordinals in OpenType fonts.
otfOverlapSwashbool r/wIf true, use overlapping swash forms in OpenType fonts
otfProportionalMetricsbool r/wIf true, kerns according to proportional CJK metrics in OpenType fonts.
otfRomanItalicsbool r/wIf true, applies italics to half-width alphanumerics.
otfSlashedZerobool r/wIf true, use a slashed zeroes in OpenType fonts.
otfStretchedAlternatebool r/wIf true, use stretched alternate forms in OpenType fonts
otfStylisticAlternatebool r/wIf true, use stylistic alternate forms in OpenType fonts
otfStylisticSetsnumber r/wThe stylistic sets to use in OpenType fonts.
otfSwashbool r/wIf true, uses swash forms in OpenType fonts.
otfTitlingbool r/wIf true, uses titling forms in OpenType fonts.
ovalsOvals readonlyA collection of ellipses.
overprintFillbool r/wIf true, the fill color of the characters will overprint.
overprintStrokebool r/wIf true, the stroke of the characters will overprint.
pageItemsPageItems readonlyThe 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.
paragraphDirectionParagraphDirectionOptions:
ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION
ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wParagraph direction.
paragraphGyoudoribool r/wIf true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph.
paragraphJustificationParagraphJustificationOptions:
ParagraphJustificationOptions.DEFAULT_JUSTIFICATION
ParagraphJustificationOptions.ARABIC_JUSTIFICATION
ParagraphJustificationOptions.NASKH_JUSTIFICATION
ParagraphJustificationOptions.NASKH_TATWEEL_JUSTIFICATION
ParagraphJustificationOptions.NASKH_KASHIDA_JUSTIFICATION
ParagraphJustificationOptions.NASKH_TATWEEL_JUSTIFICATION_FRAC
ParagraphJustificationOptions.NASKH_KASHIDA_JUSTIFICATION_FRAC
r/wParagraph justification.
paragraphKashidaWidthnumber r/wParagraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long
paragraphsParagraphs readonlyA collection of paragraphs.
parentCell
Change
Character
Footnote
HiddenText
InsertionPoint
Line
Note
Paragraph
Story
Text
TextColumn
TextFrame
TextPath
TextStyleRange
Word
XMLElement
XmlStory
readonlyThe parent of the Character (a XmlStory, TextPath, TextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, Change or HiddenText).
parentStoryStory readonlyThe story that contains the text.
parentTextFramesArray of
TextFrames
TextPaths
readonlyAn array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths.
pointSizeMeasurement Unit (Number or String) r/wThe text size.
polygonsPolygons readonlyA collection of polygons.
positionPosition:
Position.NORMAL
Position.SUPERSCRIPT
Position.SUBSCRIPT
Position.OT_SUPERSCRIPT
Position.OT_SUBSCRIPT
Position.OT_NUMERATOR
Position.OT_DENOMINATOR
r/wThe text position relative to the baseline.
positionalFormPositionalForms:
PositionalForms.NONE
PositionalForms.CALCULATE
PositionalForms.INITIAL
PositionalForms.MEDIAL
PositionalForms.FINAL
PositionalForms.ISOLATED
r/wThe OpenType positional form.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
radioButtonsRadioButtons readonlyA collection of radio buttons.
rectanglesRectangles readonlyA collection of rectangles.
rensuujibool r/wIf true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers.
rightIndentMeasurement Unit (Number or String) r/wThe width of the right indent.
rotateSingleByteCharactersbool r/wIf true, rotates Roman characters in vertical text.
rubyAlignmentRubyAlignments:
RubyAlignments.RUBY_LEFT
RubyAlignments.RUBY_CENTER
RubyAlignments.RUBY_RIGHT
RubyAlignments.RUBY_FULL_JUSTIFY
RubyAlignments.RUBY_JIS
RubyAlignments.RUBY_EQUAL_AKI
RubyAlignments.RUBY_1_AKI
r/wThe ruby alignment.
rubyAutoAlignbool r/wIf true, auto aligns ruby.
rubyAutoScalingbool r/wIf true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent.
rubyAutoTcyAutoScalebool r/wIf true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em.
rubyAutoTcyDigitsnumber r/wThe number of digits included in auto tcy (tate-chuu-yoko) in ruby.
rubyAutoTcyIncludeRomanbool r/wIf true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby.
rubyFillString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String.
rubyFlagbool r/wIf true, ruby is on.
rubyFontFont
String
r/wThe font applied to ruby characters. Can return: Font or String.
rubyFontSizenumber r/wThe size (in points) of ruby characters.
rubyFontStyleNothingEnum
String
r/wThe font style of ruby characters. Can return: String or NothingEnum enumerator.
rubyOpenTypeProbool r/wIf true, uses OpenType Pro fonts for ruby.
rubyOverhangbool r/wIf true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount.
rubyOverprintFillAdornmentOverprint:
AdornmentOverprint.AUTO
AdornmentOverprint.OVERPRINT_ON
AdornmentOverprint.OVERPRINT_OFF
r/wThe method of overprinting the ruby fill.
rubyOverprintStrokeAdornmentOverprint:
AdornmentOverprint.AUTO
AdornmentOverprint.OVERPRINT_ON
AdornmentOverprint.OVERPRINT_OFF
r/wThe method of overprinting the ruby stroke.
rubyParentOverhangAmountRubyOverhang:
RubyOverhang.NONE
RubyOverhang.RUBY_OVERHANG_ONE_RUBY
RubyOverhang.RUBY_OVERHANG_HALF_RUBY
RubyOverhang.RUBY_OVERHANG_ONE_CHAR
RubyOverhang.RUBY_OVERHANG_HALF_CHAR
RubyOverhang.RUBY_OVERHANG_NO_LIMIT
r/wThe amount by which ruby characters can overhang the parent text.
rubyParentScalingPercentnumber r/wThe amount (as a percentage) to scale the parent text size to determine the ruby text size.
rubyParentSpacingRubyParentSpacing:
RubyParentSpacing.RUBY_PARENT_NO_ADJUSTMENT
RubyParentSpacing.RUBY_PARENT_BOTH_SIDES
RubyParentSpacing.RUBY_PARENT_121_AKI
RubyParentSpacing.RUBY_PARENT_EQUAL_AKI
RubyParentSpacing.RUBY_PARENT_FULL_JUSTIFY
r/wThe ruby spacing relative to the parent text.
rubyPositionRubyKentenPosition:
RubyKentenPosition.ABOVE_RIGHT
RubyKentenPosition.BELOW_LEFT
r/wThe position of ruby characters relative to the parent text.
rubyStringstring r/wThe ruby string contents.
rubyStrokeString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String.
rubyStrokeTintnumber r/wThe stroke tint (as a percentage) of ruby characters.
rubyTintnumber r/wThe tint (as a percentage) of the ruby fill color. (Range: 0 to 100)
rubyTypeRubyTypes:
RubyTypes.GROUP_RUBY
RubyTypes.PER_CHARACTER_RUBY
r/wThe ruby type.
rubyWeightnumber r/wThe stroke weight (in points) of ruby characters.
rubyXOffsetnumber r/wThe amount of horizontal space between ruby and parent characters.
rubyXScalenumber r/wThe horizontal size of ruby characters, specified as a percent of the original size.
rubyYOffsetnumber r/wThe amount of vertical space between ruby and parent characters.
rubyYScalenumber r/wThe vertical size of ruby characters, specified as a percent of the original size.
ruleAbovebool r/wIf true, places a rule above the paragraph.
ruleAboveColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
ruleAboveGapColorString
Swatch
r/wThe 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.
ruleAboveGapOverprintbool r/wIf true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
ruleAboveGapTintnumber r/wThe 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.
ruleAboveLeftIndentMeasurement Unit (Number or String) r/wThe 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.
ruleAboveLineWeightMeasurement Unit (Number or String) r/wThe line weight of the rule above.
ruleAboveOffsetMeasurement Unit (Number or String) r/wThe amount to offset the paragraph rule above from the baseline of the first line the paragraph.
ruleAboveOverprintbool r/wIf true, the paragraph rule above will overprint.
ruleAboveRightIndentMeasurement Unit (Number or String) r/wThe 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.
ruleAboveTintnumber r/wThe tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
ruleAboveTypeString
StrokeStyle
r/wThe stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
ruleAboveWidthRuleWidth:
RuleWidth.TEXT_WIDTH
RuleWidth.COLUMN_WIDTH
r/wThe basis (text width or column width) used to calculate the width of the paragraph rule above.
ruleBelowbool r/wIf true, applies a paragraph rule below.
ruleBelowColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
ruleBelowGapColorString
Swatch
r/wThe 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.
ruleBelowGapOverprintbool r/wIf true, the gap color of the rule below will overprint.
ruleBelowGapTintnumber r/wThe 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.
ruleBelowLeftIndentMeasurement Unit (Number or String) r/wThe 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.
ruleBelowLineWeightMeasurement Unit (Number or String) r/wThe line weight of the rule below.
ruleBelowOffsetMeasurement Unit (Number or String) r/wThe amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
ruleBelowOverprintbool r/wIf true, the rule below will overprint.
ruleBelowRightIndentMeasurement Unit (Number or String) r/wThe 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.
ruleBelowTintnumber r/wThe tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
ruleBelowTypeString
StrokeStyle
r/wThe stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
ruleBelowWidthRuleWidth:
RuleWidth.TEXT_WIDTH
RuleWidth.COLUMN_WIDTH
r/wThe basis (text width or column width) used to calculate the width of the paragraph rule below.
scaleAffectsLineHeightbool r/wIf true, the line changes size when characters are scaled.
shataiAdjustRotationbool r/wIf true, applies shatai rotation.
shataiAdjustTsumebool r/wIf true, adjusts shatai tsume.
shataiDegreeAnglenumber r/wThe shatai lens angle (in degrees).
shataiMagnificationnumber r/wThe amount (as a percentage) of shatai obliquing to apply.
signatureFieldsSignatureFields readonlyA collection of signature fields.
singleWordJustificationSingleWordJustification:
SingleWordJustification.LEFT_ALIGN
SingleWordJustification.CENTER_ALIGN
SingleWordJustification.RIGHT_ALIGN
SingleWordJustification.FULLY_JUSTIFIED
r/wThe alignment to use for lines that contain a single word.
skewnumber r/wThe skew angle of the Character.
spaceAfterMeasurement Unit (Number or String) r/wThe height of the paragraph space below.
spaceBeforeMeasurement Unit (Number or String) r/wThe height of the paragraph space above.
spanColumnMinSpaceAfterMeasurement Unit (Number or String) r/wThe minimum space after a span or a split column
spanColumnMinSpaceBeforeMeasurement Unit (Number or String) r/wThe minimum space before a span or a split column
spanColumnTypeSpanColumnTypeOptions:
SpanColumnTypeOptions.SINGLE_COLUMN
SpanColumnTypeOptions.SPAN_COLUMNS
SpanColumnTypeOptions.SPLIT_COLUMNS
r/wWhether a paragraph should be a single column, span columns or split columns
spanSplitColumnCountShort Integer (1 - 40)
SpanColumnCountOptions
r/wThe number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator.
splineItemsSplineItems readonlyThe spline items collection.
splitColumnInsideGutterMeasurement Unit (Number or String) r/wThe inside gutter if the paragraph splits columns
splitColumnOutsideGutterMeasurement Unit (Number or String) r/wThe outside gutter if the paragraph splits columns
startParagraphStartParagraph:
StartParagraph.ANYWHERE
StartParagraph.NEXT_COLUMN
StartParagraph.NEXT_FRAME
StartParagraph.NEXT_PAGE
StartParagraph.NEXT_ODD_PAGE
StartParagraph.NEXT_EVEN_PAGE
r/wThe location at which to start the paragraph.
strikeThroughColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapOverprintbool r/wIf true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
strikeThroughGapTintnumber 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.
strikeThroughOffsetMeasurement Unit (Number or String) r/wThe amount by which to offset the strikethrough stroke from the text baseline.
strikeThroughOverprintbool r/wIf true, the strikethrough stroke will overprint.
strikeThroughTintnumber r/wThe tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
strikeThroughTypeString
StrokeStyle
r/wThe stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
strikeThroughWeightMeasurement Unit (Number or String) r/wThe stroke weight of the strikethrough stroke.
strikeThrubool r/wIf true, draws a strikethrough line through the text.
strokeAlignmentTextStrokeAlign:
TextStrokeAlign.CENTER_ALIGNMENT
TextStrokeAlign.OUTSIDE_ALIGNMENT
r/wThe stroke alignment applied to the text.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Character. Can also accept: String.
strokeTintnumber r/wThe 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.)
strokeWeightMeasurement Unit (Number or String) r/wThe stroke weight applied to the characters of the text.
styleOverriddenbool readonlyIf true, the applied style has been overridden with additional attributes.
tabListArray of
Arrays of Property Name/Value Pairs
r/wA list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
tabStopsTabStops readonlyA collection of tab stops.
tablesTables readonlyA collection of tables.
tatechuyokobool r/wIf true, makes the character horizontal in vertical text.
tatechuyokoXOffsetnumber r/wThe horizontal offset for horizontal characters in vertical text.
tatechuyokoYOffsetnumber r/wThe vertical offset for horizontal characters in vertical text.
textBoxesTextBoxes readonlyA collection of text boxes.
textColumnsTextColumns readonlyA collection of text columns.
textFramesTextFrames readonlyA collection of text frames.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
textsTexts readonlyA collection of text objects.
trackingnumber r/wThe amount by which to loosen or tighten a block of text, specified in thousands of an em.
trailingAkinumber r/wThe amount of space after each character.
treatIdeographicSpaceAsSpacebool r/wIf true, ideographic spaces will not wrap to the next line like text characters.
tsumenumber r/wThe amount of horizontal character compression.
underlinebool r/wIf true, underlines the text.
underlineColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
underlineGapColorString
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 or String.
underlineGapOverprintbool r/wIf true, the gap color of the underline stroke will overprint.
underlineGapTintnumber 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.
underlineOffsetMeasurement Unit (Number or String) r/wThe amount by which to offset the underline from the text baseline.
underlineOverprintbool r/wIf true, the underline stroke color will overprint.
underlineTintnumber r/wThe underline stroke tint (as a percentage). (Range: 0 to 100)
underlineTypeString
StrokeStyle
r/wThe stroke type of the underline stroke. Can return: StrokeStyle or String.
underlineWeightMeasurement Unit (Number or String) r/wThe stroke weight of the underline stroke.
verticalScalenumber r/wThe vertical scaling applied to the Character.
warichubool r/wIf true, turns on warichu.
warichuAlignmentWarichuAlignment:
WarichuAlignment.AUTO
WarichuAlignment.LEFT_ALIGN
WarichuAlignment.CENTER_ALIGN
WarichuAlignment.RIGHT_ALIGN
WarichuAlignment.FULLY_JUSTIFIED
WarichuAlignment.LEFT_JUSTIFIED
WarichuAlignment.CENTER_JUSTIFIED
WarichuAlignment.RIGHT_JUSTIFIED
r/wThe warichu alignment.
warichuCharsAfterBreaknumber r/wThe minimum number of characters allowed after a line break.
warichuCharsBeforeBreaknumber r/wThe minimum number of characters allowed before a line break.
warichuLineSpacingnumber r/wThe gap between lines of warichu characters.
warichuLinesnumber r/wThe number of lines of warichu within a single normal line.
warichuSizenumber r/wThe amount (as a percentage) to scale parent text size to determine warichu size.
wordsWords readonlyA collection of words.
xOffsetDiacriticnumber r/wThe x (horizontal) offset for diacritic adjustment.
yOffsetDiacriticnumber r/wThe y (vertical) offset for diacritic adjustment.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void applyCharacterStyle (using: CharacterStyle)
Apply a character style.

ParameterTypeDescription
usingCharacterStyleThe character style to apply.

void applyConditions (using: Array of Condition[, removeExisting: bool=false])
Apply one or more conditions.

ParameterTypeDescription
usingArray of ConditionThe condition(s) to apply
removeExistingboolIf true, remove existing conditions. (Optional) (default: false)

void applyParagraphStyle (using: ParagraphStyle[, clearingOverrides: bool=true])
Apply a paragraph style.

ParameterTypeDescription
usingParagraphStyleThe paragraph style to apply.
clearingOverridesboolIf true, clear any text attributes before applying the style. (Optional) (default: true)

BackgroundTask asynchronousExportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
asynchronously exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

void changecase (using: ChangecaseMode)
Sets the case of the text.

ParameterTypeDescription
usingChangecaseMode:
ChangecaseMode.UPPERCASE
ChangecaseMode.LOWERCASE
ChangecaseMode.TITLECASE
ChangecaseMode.SENTENCECASE
The text case option.

void clearOverrides ([overridesToClear: OverrideType=OverrideType.ALL])
Clears the specified types of override.

ParameterTypeDescription
overridesToClearOverrideType:
OverrideType.ALL
OverrideType.CHARACTER_ONLY
OverrideType.PARAGRAPH_ONLY
The types of override to clear. (Optional) (default: OverrideType.ALL)

void convertBulletsAndNumberingToText ()
Convert bullets and numbering to text.

Note convertToNote ()
Converts the text to a note.

Table convertToTable ([columnSeparator: string][, rowSeparator: string][, numberOfColumns: number=1])
Converts the text to a table.

ParameterTypeDescription
columnSeparatorstringThe character that starts a new column in the new table. (Optional)
rowSeparatorstringThe character starts a new row in the new table. (Optional)
numberOfColumnsnumberThe number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) (default: 1)

Array of PageItem createOutlines ([deleteOriginal: bool=true])
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.

ParameterTypeDescription
deleteOriginalboolIf true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) (default: true)

Text duplicate (to: LocationOptions[, reference: varies])
Duplicates the text in the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceCell
Column
PageItem
Row
Story
Table
Text
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)

void exportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

ParameterTypeDescription
formatExportFormat
String
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.
toFileThe path to the export file.
showingOptionsboolIf true, displays the export options dialog. (Optional) (default: false)
usingPDFExportPresetThe export style. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of HyperlinkTextSource findHyperlinks ([sortOrder: RangeSortOrder])
Finds hyperlink sources that intersecting with specified text range.

ParameterTypeDescription
sortOrderRangeSortOrder:
RangeSortOrder.NO_SORT
RangeSortOrder.ASCENDING_SORT
RangeSortOrder.DESCENDING_SORT
The sort order of found ranges. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

ParameterTypeDescription
reverseOrderboolIf true, returns the results in reverse order. (Optional)

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

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

ParameterTypeDescription
usingXMLElementThe XML element.

Text move (to: LocationOptions[, reference: varies])
Moves the text to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceCell
Column
PageItem
Row
Story
Table
Text
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)

Array of any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Places the file.

ParameterTypeDescription
fileNameFileThe file to place
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
withPropertiesObjectInitial values for properties of the placed object(s) (Optional)

void recompose ()
Recomposes the text in the Character.

void remove ()
Deletes the Character.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
SelectionOptions.SET_KEY
The selection status of the Character in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

void showText ()
Jump to the text range.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Button.parent

EPSText.parent

FormField.parent

Group.parent

MultiStateObject.parent

Used in:

Character Characters.nextItem (obj: Character)

Character Characters.previousItem (obj: Character)

Return

Array of Character Character.getElements ()

Character Characters.[] (index: number)

Character Characters.anyItem ()

Array of Character Characters.everyItem ()

Character Characters.firstItem ()

Character Characters.item (index: varies)

Array of Character Characters.itemByRange (from: varies, to: varies)

Character Characters.lastItem ()

Character Characters.middleItem ()

Character Characters.nextItem (obj: Character)

Character Characters.previousItem (obj: Character)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index