TextColumn
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
alignToBaseline | bool | r/w | If true, aligns the baseline of the text to the baseline grid. |
allGraphics | Array of Graphic | readonly | Lists all graphics contained by the TextColumn. |
allPageItems | Array of PageItem | readonly | Lists all page items contained by the TextColumn. |
appliedCharacterStyle | CharacterStyleString | r/w | The character style applied to the text. Can also accept: String. |
appliedFont | Font String |
r/w | The font applied to the text, specified as either a font object or the name of font family. Can return: Font or String. |
appliedLanguage | Language LanguageWithVendors String |
r/w | The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String. |
appliedParagraphStyle | ParagraphStyle String |
r/w | The paragraph style applied to the text. Can also accept: String. |
ascent | Measurement Unit (Number or String) | readonly | The maximum ascent of any character in the text. |
associatedXMLElements | Array of XMLItem | readonly | The XML elements associated with the TextColumn. |
autoLeading | number | r/w | The percent of the type size to use for auto leading. (Range: 0 to 500). |
balanceRaggedLines | BalanceLinesStyle Boolean |
r/w | If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean or BalanceLinesStyle enumerator. |
baseline | Measurement Unit (Number or String) | readonly | The vertical offset of the text. |
baselineShift | Measurement Unit (Number or String) | r/w | The baseline shift applied to the text. |
bulletChar | Bullet | readonly | Bullet character. |
bulletsAndNumberingColor | AutoEnum String Swatch |
r/w | Color of the bullet or number character. Can return: AutoEnum enumerator, Swatch or String. |
bulletsAndNumberingListType | ListType: ListType.NO_LIST ListType.BULLET_LIST ListType.NUMBERED_LIST |
r/w | List type for bullets and numbering. |
bulletsAndNumberingSize | AutoEnum Real |
r/w | Point size of the bullet or number character. Can return: AutoEnum enumerator or Real. |
buttons | Buttons | readonly | A collection of buttons. |
capitalization | Capitalization: Capitalization.NORMAL Capitalization.SMALL_CAPS Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP |
r/w | The capitalization scheme. |
characterDirection | CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | The direction of the character. |
characters | Characters | readonly | A collection of characters. |
composer | string | r/w | The text composer to use to compose the text. |
contents | SpecialCharacters String |
r/w | The contents of the text. Can return: String or SpecialCharacters enumerator. |
descent | Measurement Unit (Number or String) | readonly | The maximum descent of any character in the text. |
desiredGlyphScaling | number | r/w | The desired width (as a percentage) of individual characters. (Range: 50 to 200) |
desiredLetterSpacing | number | r/w | The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) |
desiredWordSpacing | number | r/w | The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000) |
diacriticPosition | DiacriticPositionOptions: DiacriticPositionOptions.DEFAULT_POSITION DiacriticPositionOptions.LOOSE_POSITION DiacriticPositionOptions.MEDIUM_POSITION DiacriticPositionOptions.TIGHT_POSITION DiacriticPositionOptions.OPENTYPE_POSITION |
r/w | Position of diacriticical characters. |
digitsType | DigitsTypeOptions: 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/w | The digits type. |
dropCapCharacters | number | r/w | Number of characters for drop cap. |
dropCapLines | number | r/w | Number of lines for drop cap. |
dropCapStyle | CharacterStyle String |
r/w | The character style to apply to the drop cap. Can also accept: String. |
fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the text. . Can also accept: String. |
fillTint | number | r/w | The tint (as a percentage) of the fill color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
firstLineIndent | Measurement Unit (Number or String) | r/w | The amount to indent the first line. |
fontStyle | string | r/w | The name of the font style. |
footnotes | Footnotes | readonly | A collection of footnotes. |
formFields | FormFields | readonly | A collection of form fields. |
gradientFillAngle | number | r/w | The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180) |
gradientFillLength | number | r/w | The 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/w | The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. |
gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180) |
gradientStrokeLength | number | r/w | The 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/w | The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. |
graphicLines | GraphicLines | readonly | A collection of graphic lines. |
gridAlignFirstLineOnly | bool | r/w | If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid. |
groups | Groups | readonly | A collection of groups. |
horizontalOffset | Measurement Unit (Number or String) | readonly | The horizontal offset of the text. |
horizontalScale | number | r/w | The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
hyphenWeight | number | r/w | Hyphen weight. |
hyphenateAfterFirst | number | r/w | Hyphenate after this many letters. |
hyphenateBeforeLast | number | r/w | Hyphenate before this many letters. |
hyphenateCapitalizedWords | bool | r/w | If true, allows hyphenation of capitalized words. |
hyphenateLadderLimit | number | r/w | Number of consecutive hyphens to allow. |
hyphenateLastWord | bool | r/w | If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. |
hyphenateWordsLongerThan | number | r/w | Hyphenate words that have more than this number of letters. |
hyphenation | bool | r/w | If true, allows hyphenation. |
hyphenationZone | Measurement Unit (Number or String) | r/w | 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. |
index | number | readonly | The index of the text in the collection or parent object. |
insertionPoints | InsertionPoints | readonly | A collection of insertion points. |
justification | Justification: 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/w | The paragraph alignment. |
kashidas | KashidasOptions: KashidasOptions.DEFAULT_KASHIDAS KashidasOptions.KASHIDAS_OFF |
r/w | Use of Kashidas for justification |
keepAllLinesTogether | bool | r/w | If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. |
keepFirstLines | number | r/w | Keep at least this many lines together at the end of a column. |
keepLastLines | number | r/w | Keep at least this many lines together at the start of a column. |
keepLinesTogether | bool | r/w | If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. |
keepWithNext | number | r/w | Keep at least this many lines together with the following paragraph. |
kerningMethod | string | r/w | The type of pair kerning. |
kerningValue | number | r/w | The amount of space to add or remove between characters, specified in thousands of an em. |
keyboardDirection | CharacterDirectionOptions: CharacterDirectionOptions.DEFAULT_DIRECTION CharacterDirectionOptions.LEFT_TO_RIGHT_DIRECTION CharacterDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | The keyboard direction of the character. |
lastLineIndent | Measurement Unit (Number or String) | r/w | The amount to indent the last line in the paragraph. |
leading | Leading Unit |
r/w | The leading applied to the text. Can return: Unit or Leading enumerator. |
leftIndent | Measurement Unit (Number or String) | r/w | The width of the left indent. |
length | number | readonly | The number of objects in the collection. |
ligatures | bool | r/w | If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. |
lines | Lines | readonly | A collection of lines. |
maximumGlyphScaling | number | r/w | The maximum width (as a percentage) of individual characters. (Range: 50 to 200) |
maximumLetterSpacing | number | r/w | 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. |
maximumWordSpacing | number | r/w | 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) |
minimumGlyphScaling | number | r/w | The minimum width (as a percentage) of individual characters. (Range: 50 to 200) |
minimumLetterSpacing | number | r/w | 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. |
minimumWordSpacing | number | r/w | 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) |
nestedStyles | NestedStyles | readonly | A collection of nested styles. |
noBreak | bool | r/w | If true, keeps the text on the same line. |
notes | Notes | readonly | A collection of notes. |
numberSeparator | number | r/w | The numbering separator as a unicode ID. |
numberStartAt | number | r/w | Starting number in a numbered list. |
numberingFont | AutoEnum Font String |
r/w | Font of the number character. Can return: Font, String or AutoEnum enumerator. |
numberingFontStyle | AutoEnum NothingEnum String |
r/w | Font style of the number character. Can return: String, NothingEnum enumerator or AutoEnum enumerator. |
numberingStyle | NumberingStyle String |
r/w | Numbering style. Can return: NumberingStyle enumerator or String. |
opentypeFeatures |
Array
of Array of 2 Strings Longs |
r/w | OpenType features. Can return: Array of Array of 2 Strings or Longs. |
otfContextualAlternate | bool | r/w | If true, uses contextual alternate forms in OpenType fonts. |
otfDiscretionaryLigature | bool | r/w | If true, uses discretionary ligatures in OpenType fonts. |
otfFigureStyle | OTFFigureStyle: OTFFigureStyle.TABULAR_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.TABULAR_OLDSTYLE OTFFigureStyle.DEFAULT_VALUE |
r/w | The figure style in OpenType fonts. |
otfFraction | bool | r/w | If true, uses fractions in OpenType fonts. |
otfHistorical | bool | r/w | If true, use historical forms in OpenType fonts. |
otfJustificationAlternate | bool | r/w | If true, use alternate justification forms in OpenType fonts |
otfOrdinal | bool | r/w | If true, uses ordinals in OpenType fonts. |
otfOverlapSwash | bool | r/w | If true, use overlapping swash forms in OpenType fonts |
otfSlashedZero | bool | r/w | If true, use a slashed zeroes in OpenType fonts. |
otfStretchedAlternate | bool | r/w | If true, use stretched alternate forms in OpenType fonts |
otfStylisticAlternate | bool | r/w | If true, use stylistic alternate forms in OpenType fonts |
otfStylisticSets | number | r/w | The stylistic sets to use in OpenType fonts. |
otfSwash | bool | r/w | If true, uses swash forms in OpenType fonts. |
otfTitling | bool | r/w | If true, uses titling forms in OpenType fonts. |
ovals | Ovals | readonly | A collection of ellipses. |
overprintFill | bool | r/w | If true, the fill color of the characters will overprint. |
overprintStroke | bool | r/w | If true, the stroke of the characters will overprint. |
pageItems | PageItems | 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. |
paragraphDirection | ParagraphDirectionOptions: ParagraphDirectionOptions.LEFT_TO_RIGHT_DIRECTION ParagraphDirectionOptions.RIGHT_TO_LEFT_DIRECTION |
r/w | Paragraph direction. |
paragraphJustification | ParagraphJustificationOptions: ParagraphJustificationOptions.DEFAULT_JUSTIFICATION ParagraphJustificationOptions.ARABIC_JUSTIFICATION ParagraphJustificationOptions.NASKH_JUSTIFICATION |
r/w | Paragraph justification. |
paragraphs | Paragraphs | readonly | A collection of paragraphs. |
parent | Cell Character Footnote InsertionPoint Line Note Paragraph Story Text TextColumn TextFrame TextPath TextStyleRange Word XMLElement |
readonly | The parent of the TextColumn (a TextPath, TextFrame, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, InsertionPoint, Story, Cell, XMLElement, Footnote or Note). |
parentStory | Story | readonly | The story that contains the text. |
parentTextFrames |
Array
of TextFrames TextPaths |
readonly | An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths. |
pointSize | Measurement Unit (Number or String) | r/w | The text size. |
polygons | Polygons | readonly | A collection of polygons. |
position | Position: Position.NORMAL Position.SUPERSCRIPT Position.SUBSCRIPT Position.OT_SUPERSCRIPT Position.OT_SUBSCRIPT Position.OT_NUMERATOR Position.OT_DENOMINATOR |
r/w | The text position relative to the baseline. |
properties | Object | r/w | A property that allows setting of several properties at the same time. |
rectangles | Rectangles | readonly | A collection of rectangles. |
rightIndent | Measurement Unit (Number or String) | r/w | The width of the right indent. |
ruleAbove | bool | r/w | If true, places a rule above the paragraph. |
ruleAboveColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String. |
ruleAboveGapColor | String Swatch |
r/w | 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. |
ruleAboveGapOverprint | bool | r/w | If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid. |
ruleAboveGapTint | number | r/w | 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. |
ruleAboveLeftIndent | Measurement Unit (Number or String) | r/w | 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. |
ruleAboveLineWeight | number | r/w | The stoke weight of the paragraph rule above. |
ruleAboveOffset | Measurement Unit (Number or String) | r/w | The amount to offset the paragraph rule above from the baseline of the first line the paragraph. |
ruleAboveOverprint | bool | r/w | If true, the paragraph rule above will overprint. |
ruleAboveRightIndent | Measurement Unit (Number or String) | r/w | 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. |
ruleAboveTint | number | r/w | The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) |
ruleAboveType | String StrokeStyle |
r/w | The stroke type of the rule above the paragraph. Can return: StrokeStyle or String. |
ruleAboveWidth | RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule above. |
ruleBelow | bool | r/w | If true, applies a paragraph rule below. |
ruleBelowColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String. |
ruleBelowGapColor | String Swatch |
r/w | 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. |
ruleBelowGapOverPrint | bool | r/w | If true, overprint the paragraph rule below stroke gap color. |
ruleBelowGapTint | number | r/w | 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. |
ruleBelowLeftIndent | Measurement Unit (Number or String) | r/w | 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. |
ruleBelowLineWeight | number | r/w | The stroke weight of the paragraph rule below. |
ruleBelowOffset | Measurement Unit (Number or String) | r/w | The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. |
ruleBelowOverPrint | bool | r/w | If true, overprint the paragraph rule below. |
ruleBelowRightIndent | Measurement Unit (Number or String) | r/w | 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. |
ruleBelowTint | number | r/w | The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) |
ruleBelowType | String StrokeStyle |
r/w | The stroke type of the rule below the paragraph. Can return: StrokeStyle or String. |
ruleBelowWidth | RuleWidth: RuleWidth.TEXT_WIDTH RuleWidth.COLUMN_WIDTH |
r/w | The basis (text width or column width) used to calculate the width of the paragraph rule below. |
singleWordJustification | SingleWordJustification: SingleWordJustification.LEFT_ALIGN SingleWordJustification.CENTER_ALIGN SingleWordJustification.RIGHT_ALIGN SingleWordJustification.FULLY_JUSTIFIED |
r/w | The alignment to use for lines that contain a single word. |
skew | number | r/w | The skew angle of the text. (Range: -85 to 85) |
spaceAfter | Measurement Unit (Number or String) | r/w | The height of the paragraph space below. |
spaceBefore | Measurement Unit (Number or String) | r/w | The height of the paragraph space above. |
startParagraph | StartParagraph: StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_FRAME StartParagraph.NEXT_PAGE StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_EVEN_PAGE |
r/w | The location at which to start the paragraph. |
strikeThroughColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String. |
strikeThroughGapColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String. |
strikeThroughGapOverprint | bool | r/w | If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. |
strikeThroughGapTint | number | r/w | The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid. |
strikeThroughOffset | Measurement Unit (Number or String) | r/w | The amount by which to offset the strikethrough stroke from the text baseline. |
strikeThroughOverprint | bool | r/w | If true, the strikethrough stroke will overprint. |
strikeThroughTint | number | r/w | The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) |
strikeThroughType | String StrokeStyle |
r/w | The stroke type of the strikethrough stroke. Can return: StrokeStyle or String. |
strikeThroughWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the strikethrough stroke. |
strikeThru | bool | r/w | If true, draws a strikethrough line through the text. |
strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the text. Can also accept: String. |
strokeTint | number | r/w | The tint (as a percentage) of the stroke color of the text. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
strokeWeight | Measurement Unit (Number or String) | r/w | The stroke weight applied to the characters of the text. |
tabList |
Array
of Arrays of Property Name/Value Pairs |
r/w | A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs. |
tabStops | TabStops | readonly | A collection of tab stops. |
tables | Tables | readonly | A collection of tables. |
textColumns | TextColumns | readonly | A collection of text columns. |
textFrames | TextFrames | readonly | A collection of text frames. |
textStyleRanges | TextStyleRanges | readonly | A collection of text style ranges. |
texts | Texts | readonly | A collection of text objects. |
tracking | number | r/w | The amount by which to loosen or tighten a block of text, specified in thousands of an em. |
underline | bool | r/w | If true, underlines the text. |
underlineColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String. |
underlineGapColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch or String. |
underlineGapOverprint | bool | r/w | If true, the gap color of the underline stroke will overprint. |
underlineGapTint | number | r/w | The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid. |
underlineOffset | Measurement Unit (Number or String) | r/w | The amount by which to offset the underline from the text baseline. |
underlineOverprint | bool | r/w | If true, the underline stroke color will overprint. |
underlineTint | number | r/w | The underline stroke tint (as a percentage). (Range: 0 to 100) |
underlineType | String StrokeStyle |
r/w | The stroke type of the underline stroke. Can return: StrokeStyle or String. |
underlineWeight | Measurement Unit (Number or String) | r/w | The stroke weight of the underline stroke. |
verticalScale | number | r/w | The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000) |
words | Words | readonly | A collection of words. |
xOffsetDiacritic | number | r/w | The x (horizontal) offset for diacritic adjustment. |
yOffsetDiacritic | number | r/w | The 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
Parameter | Type | Description |
---|---|---|
bulletChar | number | The bullet character as a unicode ID or a glyph ID (Optional) |
bulletType | BulletCharacterType: BulletCharacterType.UNICODE_ONLY BulletCharacterType.UNICODE_WITH_FONT BulletCharacterType.GLYPH_WITH_FONT | The type of bullet character (Optional) |
bulletFont | Font String | The bullet font. Can accept: Font or String. (Optional) |
bulletFontStyle | string | The bullet font style (Optional) |
bulletSize | number | The size of the bullet character (Optional) |
bulletColor | Swatch | The color of the bullet character (Optional) |
bulletAlignment | ListAlignment: ListAlignment.HANGING_LIST ListAlignment.FLUSH_LEFT_LIST ListAlignment.CUSTOM_ALIGNED_LIST | The alignment of the bulleted list (Optional) (default: ListAlignment.HANGING_LIST) |
listLeftIndent | number | The left indent of the bulleted list (Optional) |
listFirstLineIndent | number | The first line indent of the bulleted list (Optional) |
listFirstTabPosition | number | The 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
Parameter | Type | Description |
---|---|---|
numberingStyle | NumberingStyle: NumberingStyle.UPPER_ROMAN NumberingStyle.LOWER_ROMAN NumberingStyle.UPPER_LETTERS NumberingStyle.LOWER_LETTERS NumberingStyle.ARABIC | The numbering style to be used (Optional) |
numberingSeparator | number | The separator used for numbering (Optional) |
startingValue | number | The value with which to start numbering (Optional) |
numberFont | Font String | The number font. Can accept: Font or String. (Optional) |
numberFontStyle | string | The number font style (Optional) |
numberSize | number | The size of the number character(s) (Optional) |
numberColor | Swatch | The color of the number character(s) (Optional) |
numberAlignment | ListAlignment: ListAlignment.HANGING_LIST ListAlignment.FLUSH_LEFT_LIST ListAlignment.CUSTOM_ALIGNED_LIST | The alignment of the numbered list (Optional) (default: ListAlignment.HANGING_LIST) |
listLeftIndent | number | The left indent of the numbered list (Optional) |
listFirstLineIndent | number | The first line indent of the numbered list (Optional) |
listFirstTabPosition | number | The first tab position in the numbered list (Optional) |
void applyStyle (using:
any[, clearingOverrides:
bool=true])
Applies the specified character style or paragraph style.
Parameter | Type | Description |
---|---|---|
using | CharacterStyle ParagraphStyle | The style to apply. Can accept: ParagraphStyle or CharacterStyle. |
clearingOverrides | bool | If 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.
Parameter | Type | Description |
---|---|---|
using | ChangecaseMode: ChangecaseMode.UPPERCASE ChangecaseMode.LOWERCASE ChangecaseMode.TITLECASE ChangecaseMode.SENTENCECASE | The text case option. |
void clearOverrides ([overridesToClear:
OverrideType=OverrideType.ALL])
Clears the specified types of override.
Parameter | Type | Description |
---|---|---|
overridesToClear | OverrideType: 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.
Parameter | Type | Description |
---|---|---|
columnSeparator | string | The character that starts a new column in the new table. (Optional) |
rowSeparator | string | The character starts a new row in the new table. (Optional) |
numberOfColumns | number | The 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.
Parameter | Type | Description |
---|---|---|
deleteOriginal | bool | If 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.
Parameter | Type | Description |
---|---|---|
format | ExportFormat String | The export format. Can accept: ExportFormat enumerator or String. |
to | File | The path of the export file. |
showingOptions | bool | If true, prompts the user to select export options. (Optional) (default: false) |
using | PDFExportPreset | The 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.
Parameter | Type | Description |
---|---|---|
using | XMLElement | The XML element. |
Text move (to:
LocationOptions[, reference:
any])
Moves the text to the specified location.
Parameter | Type | Description |
---|---|---|
to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location relative to the reference object or within the containing object. |
reference | Cell 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
Parameter | Type | Description |
---|---|---|
fileName | File | The file to place |
showingOptions | bool | Whether to display the import options dialog (Optional) (default: false) |
withProperties | Object | Initial values for properties of the placed object(s) (Optional) |
void recompose ()
Recomposes the text in the TextColumn.
void remove ()
Deletes the TextColumn.
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
Parameter | Type | Description |
---|---|---|
for | string | What to look for (Optional) |
wholeWord | bool | If true, then disregard text embedded within a larger word (Optional) |
caseSensitive | bool | If true, then search only for text that matches case (Optional) |
replacingWith | string | What to replace the found text with, either a string or a special character (Optional) |
withFindAttributes | Object | A record of find preference settings to use (Optional) |
withChangeAttributes | Object | A record of change preference settings to use (Optional) |
void select ([existingSelection:
SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.
Parameter | Type | Description |
---|---|---|
existingSelection | SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH | The selection status of the TextColumn in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
string toSource ()
Generates a string which, if executed, will return the TextColumn.
Used in:
Table Tables.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
array of TextColumn TextColumns.itemByRange (from: any, to: any)
TextColumn TextColumns.nextItem (obj: TextColumn)
TextColumn TextColumns.previousItem (obj: TextColumn)
Return
TextColumn TextColumns.anyItem ()
Array of TextColumn TextColumns.everyItem ()
TextColumn TextColumns.firstItem ()
TextColumn TextColumns.item (index: any)
TextColumn TextColumns.itemByName (name: string)
Array of TextColumn TextColumns.itemByRange (from: any, to: any)
TextColumn TextColumns.lastItem ()
TextColumn TextColumns.middleItem ()
TextColumn TextColumns.nextItem (obj: TextColumn)
TextColumn TextColumns.previousItem (obj: TextColumn)
Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |