Adobe InDesign CS2 (4.0) Object Model JS: Word

InDesign CS2

Class

Word

 A word. Base Class: Text

QuickLinks

applyBullets, applyNumbers, applyStyle, changecase, clearOverrides, convertBulletsAndNumberingToText, convertToNote, convertToTable, createOutlines, exportFile, getElements, markup, move, place, recompose, remove, removeBulletsAndNumbers, search, select, toSource, toSpecifier

Hierarchy

Cell | Character | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement
Text
Word
Bullet | Button | Character | Footnote | FormField | GraphicLine | Group | InsertionPoint | Line | NestedStyle | Note | Oval | PageItem | Paragraph | Polygon | Rectangle | TabStop | Table | Text | TextColumn | TextFrame | TextStyleRange | Word

Properties

PropertyTypeAccessDescription
alignToBaselinebool r/wIf true, aligns the baseline of the text to the baseline grid.
allGraphics Array of Graphic readonlyLists all graphics contained by the Word.
allPageItems Array of PageItem readonlyLists all page items contained by the Word.
appliedCharacterStyleCharacterStyleString r/wThe character style applied to the text. Can also accept: String.
appliedFontFont
String
r/wThe font applied to the text, 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.
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.
associatedXMLElements Array of XMLItem readonlyThe XML elements associated with the Word.
autoLeadingnumber r/wThe percent of the type size to use for auto leading. (Range: 0 to 500).
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.
bulletsAndNumberingColorAutoEnum
String
Swatch
r/wColor of the bullet or number character. Can return: AutoEnum enumerator, Swatch or String.
bulletsAndNumberingListTypeListType:
ListType.NO_LIST
ListType.BULLET_LIST
ListType.NUMBERED_LIST
r/wList type for bullets and numbering.
bulletsAndNumberingSizeAutoEnum
Real
r/wPoint size of the bullet or number character. Can return: AutoEnum enumerator or Real.
buttonsButtons readonlyA collection of buttons.
capitalizationCapitalization:
Capitalization.NORMAL
Capitalization.SMALL_CAPS
Capitalization.ALL_CAPS
Capitalization.CAP_TO_SMALL_CAP
r/wThe capitalization scheme.
characterDirectionCharacterDirectionOptions:
CharacterDirectionOptions.DEFAULT_DIRECTION
CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION
CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION
r/wThe direction of the character.
charactersCharacters readonlyA collection of characters.
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
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 r/wNumber of characters for drop cap.
dropCapLinesnumber r/wNumber of lines for drop cap.
dropCapStyleCharacterStyle
String
r/wThe character style to apply to the drop cap. Can also accept: String.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: String.
fillTintnumber r/wThe tint (as a percentage) of the fill color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
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.
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.
gradientFillStart Array 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.
gradientStrokeStart Array 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.
groupsGroups readonlyA collection of groups.
horizontalOffsetMeasurement Unit (Number or String) readonlyThe horizontal offset of the text.
horizontalScalenumber r/wThe horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
hyphenWeightnumber r/wHyphen weight.
hyphenateAfterFirstnumber r/wHyphenate after this many letters.
hyphenateBeforeLastnumber r/wHyphenate before this many letters.
hyphenateCapitalizedWordsbool r/wIf true, allows hyphenation of capitalized words.
hyphenateLadderLimitnumber r/wNumber of consecutive hyphens to allow.
hyphenateLastWordbool r/wIf true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
hyphenateWordsLongerThannumber r/wHyphenate words that have more than this number of letters.
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.
indexnumber readonlyThe index of the text in the collection or parent object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
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 r/wKeep at least this many lines together at the end of a column.
keepLastLinesnumber r/wKeep at least this many lines together at the start of a column.
keepLinesTogetherbool r/wIf true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepWithNextnumber r/wKeep at least this many lines together with the following paragraph.
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.
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.
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.
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)
nestedStylesNestedStyles readonlyA collection of nested styles.
noBreakbool r/wIf true, keeps the text on the same line.
notesNotes readonlyA collection of notes.
numberSeparatornumber r/wThe numbering separator as a unicode ID.
numberStartAtnumber r/wStarting number in a numbered list.
numberingFontAutoEnum
Font
String
r/wFont of the number character. Can return: Font, String or AutoEnum enumerator.
numberingFontStyleAutoEnum
NothingEnum
String
r/wFont style of the number character. Can return: String, NothingEnum enumerator or AutoEnum enumerator.
numberingStyleNumberingStyle
String
r/wNumbering style. Can return: NumberingStyle enumerator or String.
opentypeFeatures Array of
Array of 2 Strings
Longs
r/wOpenType features. Can return: Array of Array of 2 Strings or Longs.
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.
otfHistoricalbool r/wIf true, use historical forms in OpenType fonts.
otfJustificationAlternatebool r/wIf true, use alternate justification forms in OpenType fonts
otfOrdinalbool r/wIf true, uses ordinals in OpenType fonts.
otfOverlapSwashbool r/wIf true, use overlapping swash forms in OpenType fonts
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.
paragraphJustificationParagraphJustificationOptions:
ParagraphJustificationOptions.DEFAULT_JUSTIFICATION
ParagraphJustificationOptions.ARABIC_JUSTIFICATION
ParagraphJustificationOptions.NASKH_JUSTIFICATION
r/wParagraph justification.
paragraphsParagraphs readonlyA collection of paragraphs.
parentCell
Character
Footnote
InsertionPoint
Line
Note
Paragraph
Story
Text
TextColumn
TextFrame
TextPath
TextStyleRange
Word
XMLElement
readonlyThe parent of the Word (a TextPath, TextFrame, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, InsertionPoint, Story, Cell, XMLElement, Footnote or Note).
parentStoryStory readonlyThe story that contains the text.
parentTextFrames Array 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.
propertiesObject r/wA property that allows setting of several properties at the same time.
rectanglesRectangles readonlyA collection of rectangles.
rightIndentMeasurement Unit (Number or String) r/wThe width of the right indent.
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.
ruleAboveLineWeightnumber r/wThe stoke weight of the paragraph 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, overprint the paragraph rule below stroke gap color.
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.
ruleBelowLineWeightnumber r/wThe stroke weight of the paragraph 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, overprint the paragraph rule below.
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.
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 text. (Range: -85 to 85)
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.
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.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: String.
strokeTintnumber r/wThe tint (as a percentage) of the stroke color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeWeightMeasurement Unit (Number or String) r/wThe stroke weight applied to the characters of the text.
tabList Array 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.
textColumnsTextColumns readonlyA collection of text columns.
textFramesTextFrames readonlyA collection of text frames.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
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.
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 text as a percentage of its current size. (Range: 1 to 1000)
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

void applyBullets ([bulletChar: number][, bulletType: BulletCharacterType][, bulletFont: any][, bulletFontStyle: string][, bulletSize: number][, bulletColor: Swatch][, bulletAlignment: ListAlignment=ListAlignment.HANGING_LIST][, listLeftIndent: number][, listFirstLineIndent: number][, listFirstTabPosition: number])
Apply bullets

ParameterTypeDescription
bulletCharnumberThe bullet character as a unicode ID or a glyph ID (Optional)
bulletTypeBulletCharacterType:
BulletCharacterType.UNICODE_ONLY
BulletCharacterType.UNICODE_WITH_FONT
BulletCharacterType.GLYPH_WITH_FONT
The type of bullet character (Optional)
bulletFontFont
String
The bullet font. Can accept: Font or String. (Optional)
bulletFontStylestringThe bullet font style (Optional)
bulletSizenumberThe size of the bullet character (Optional)
bulletColorSwatchThe color of the bullet character (Optional)
bulletAlignmentListAlignment:
ListAlignment.HANGING_LIST
ListAlignment.FLUSH_LEFT_LIST
ListAlignment.CUSTOM_ALIGNED_LIST
The alignment of the bulleted list (Optional) (default: ListAlignment.HANGING_LIST)
listLeftIndentnumberThe left indent of the bulleted list (Optional)
listFirstLineIndentnumberThe first line indent of the bulleted list (Optional)
listFirstTabPositionnumberThe first tab position in the bulleted list (Optional)

void applyNumbers ([numberingStyle: NumberingStyle][, numberingSeparator: number][, startingValue: number][, numberFont: any][, numberFontStyle: string][, numberSize: number][, numberColor: Swatch][, numberAlignment: ListAlignment=ListAlignment.HANGING_LIST][, listLeftIndent: number][, listFirstLineIndent: number][, listFirstTabPosition: number])
Apply numbers

ParameterTypeDescription
numberingStyleNumberingStyle:
NumberingStyle.UPPER_ROMAN
NumberingStyle.LOWER_ROMAN
NumberingStyle.UPPER_LETTERS
NumberingStyle.LOWER_LETTERS
NumberingStyle.ARABIC
The numbering style to be used (Optional)
numberingSeparatornumberThe separator used for numbering (Optional)
startingValuenumberThe value with which to start numbering (Optional)
numberFontFont
String
The number font. Can accept: Font or String. (Optional)
numberFontStylestringThe number font style (Optional)
numberSizenumberThe size of the number character(s) (Optional)
numberColorSwatchThe color of the number character(s) (Optional)
numberAlignmentListAlignment:
ListAlignment.HANGING_LIST
ListAlignment.FLUSH_LEFT_LIST
ListAlignment.CUSTOM_ALIGNED_LIST
The alignment of the numbered list (Optional) (default: ListAlignment.HANGING_LIST)
listLeftIndentnumberThe left indent of the numbered list (Optional)
listFirstLineIndentnumberThe first line indent of the numbered list (Optional)
listFirstTabPositionnumberThe first tab position in the numbered list (Optional)

void applyStyle (using: any[, clearingOverrides: bool=true])
Applies the specified character style or paragraph style.

ParameterTypeDescription
usingCharacterStyle
ParagraphStyle
The style to apply. Can accept: ParagraphStyle or CharacterStyle.
clearingOverridesboolIf true, clears existing text attributes or character styles before applying the style. Note: Valid only when the using parameter specifies a paragraph style. (Optional) (default: true)

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)

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

ParameterTypeDescription
formatExportFormat
String
The export format. Can accept: ExportFormat enumerator or String.
toFileThe path of the export file.
showingOptionsboolIf true, prompts the user to select export options. (Optional) (default: false)
usingPDFExportPresetThe export style to use. (Optional)

Array of Object 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: any])
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)

any place (fileName: File[, showingOptions: bool=false][, withProperties: Object])
Place a 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 Word.

void remove ()
Deletes the Word.

void removeBulletsAndNumbers ()
Remove bullets and numbers

Array of Text search ([for: string][, wholeWord: bool][, caseSensitive: bool][, replacingWith: string][, withFindAttributes: Object][, withChangeAttributes: Object])
Look for occurrences of text that matches specific criteria

ParameterTypeDescription
forstringWhat to look for (Optional)
wholeWordboolIf true, then disregard text embedded within a larger word (Optional)
caseSensitiveboolIf true, then search only for text that matches case (Optional)
replacingWithstringWhat to replace the found text with, either a string or a special character (Optional)
withFindAttributesObjectA record of find preference settings to use (Optional)
withChangeAttributesObjectA record of change preference settings to use (Optional)

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

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Footnote.parent

Used in:

Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])

array of Word Words.itemByRange (from: any, to: any)

Word Words.nextItem (obj: Word)

Word Words.previousItem (obj: Word)

Return

Word Words.anyItem ()

Array of Word Words.everyItem ()

Word Words.firstItem ()

Word Words.item (index: any)

Word Words.itemByName (name: string)

Array of Word Words.itemByRange (from: any, to: any)

Word Words.lastItem ()

Word Words.middleItem ()

Word Words.nextItem (obj: Word)

Word Words.previousItem (obj: Word)

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