K4 InDesign Javascript API Documentation

TextParagraph

A paragraph.

Extends

Instance Properties

Name Description Access
alignToBaseline bool If true, aligns the baseline of the text to the baseline grid. read-write
allGraphics Graphic Lists all graphics contained by the Paragraph. read-only
allPageItems PageItem Lists all page items contained by the Paragraph. read-only
allowArbitraryHyphenation bool If true, words unassociated with a hyphenation dictionary can break to the next line on any character. read-write
appliedCharacterStyle CharacterStyle The character style applied to the text. Can also accept: String. read-write
appliedConditions Condition The applied conditions. read-write
appliedFont The font applied to the Paragraph, specified as either a font object or the name of font family. Can return: Font or String. read-write
appliedLanguage The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String. read-write
appliedNestedStyles CharacterStyle The applied character styles dictated by nested styles. read-only
appliedNumberingList The list to be part of. Can return: NumberingList or String. read-write
appliedParagraphStyle ParagraphStyle The paragraph style applied to the text. Can also accept: String. read-write
ascent Measurement Unit (Number or String)=any The maximum ascent of any character in the text. read-only
associatedXMLElements XMLItem The XML elements associated with the Paragraph. read-only
autoLeading number The percent of the type size to use for auto leading. (Range: 0 to 500). read-write
autoTcy number The number of half-width characters at or below which the characters automatically run horizontally in vertical text. read-write
autoTcyIncludeRoman bool If true, auto tcy includes Roman characters. read-write
balanceRaggedLines 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. read-write
baseline Measurement Unit (Number or String)=any The vertical offset of the text. read-only
baselineShift Measurement Unit (Number or String)=any The baseline shift applied to the text. read-write
bulletChar Bullet Bullet character. read-only
bulletsAlignment ListAlignment The alignment of the bullet character. read-write
bulletsAndNumberingListType ListType List type for bullets and numbering. read-write
bulletsAndNumberingResultText string The current bullets or numbering string. read-only
bulletsCharacterStyle The character style to be used for the text after string. Can return: CharacterStyle or String. read-write
bulletsTextAfter string The text after string expression for bullets. read-write
bunriKinshi bool If true, adds the double period (..), ellipse (...), and double hyphen (--) to the selected kinsoku set. Note: Valid only when a kinsoku set is in effect. read-write
buttons Buttons A collection of buttons. read-only
capitalization Capitalization The capitalization scheme. read-write
characterAlignment CharacterAlignment The alignment of small characters to the largest character in the line. read-write
characterDirection CharacterDirectionOptions The direction of the character. read-write
characterRotation number The rotation angle (in degrees) of individual characters. Note: The rotation is counterclockwise. read-write
characters Characters A collection of characters. read-only
checkBoxes CheckBoxes A collection of checkboxes. read-only
cjkGridTracking bool If true, uses grid tracking to track non-Roman characters in CJK grids. read-write
comboBoxes ComboBoxes A collection of comboboxes. read-only
composer string The text composer to use to compose the text. read-write
contents The contents of the text. Can return: String or SpecialCharacters enumerator. read-write
descent Measurement Unit (Number or String)=any The maximum descent of any character in the text. read-only
desiredGlyphScaling number The desired width (as a percentage) of individual characters. (Range: 50 to 200) read-write
desiredLetterSpacing number The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) read-write
desiredWordSpacing number The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000) read-write
diacriticPosition DiacriticPositionOptions Position of diacriticical characters. read-write
digitsType DigitsTypeOptions The digits type. read-write
dropCapCharacters number The number of characters to drop cap. read-write
dropCapLines number The number of lines to drop cap. read-write
dropCapStyle CharacterStyle The character style to apply to the drop cap. Can also accept: String. read-write
dropcapDetail number Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. read-write
endBaseline Measurement Unit (Number or String)=any Vertical offset of the end of the text. read-only
endHorizontalOffset Measurement Unit (Number or String)=any Horizontal offset of the end of the text. read-only
endJoin OutlineJoin The stroke join type applied to the characters of the text. read-write
endnoteRanges EndnoteRanges A collection of endnote text ranges. read-only
endnoteTextFrames EndnoteTextFrames A collection of endnote text frames. read-only
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fillColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Paragraph. . Can also accept: String. read-write
fillTint number The tint (as a percentage) of the fill color of the Paragraph. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) read-write
firstLineIndent Measurement Unit (Number or String)=any The amount to indent the first line. read-write
fontStyle string The name of the font style. read-write
footnotes Footnotes A collection of footnotes. read-only
formFields FormFields A collection of form fields. read-only
glyphForm AlternateGlyphForms The glyph variant to substitute for standard glyphs. read-write
gradientFillAngle number The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180) read-write
gradientFillLength number The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text. read-write
gradientFillStart Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y]. read-write
gradientStrokeAngle number The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180) read-write
gradientStrokeLength number The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text. read-write
gradientStrokeStart Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y]. read-write
graphicLines GraphicLines A collection of graphic lines. read-only
gridAlignFirstLineOnly bool If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid. read-write
gridAlignment GridAlignment The alignment to the frame grid or baseline grid. read-write
gridGyoudori number The manual gyoudori setting. read-write
groups Groups A collection of groups. read-only
hiddenTexts HiddenTexts A collection of hidden text objects. read-only
horizontalOffset Measurement Unit (Number or String)=any The horizontal offset of the text. read-only
horizontalScale number The horizontal scaling applied to the Paragraph. read-write
hyphenWeight number The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100) read-write
hyphenateAcrossColumns bool If true, allows the last word in a text column to be hyphenated. read-write
hyphenateAfterFirst number The mininum number of letters at the beginning of a word that can be broken by a hyphen. read-write
hyphenateBeforeLast number The minimum number of letters at the end of a word that can be broken by a hyphen. read-write
hyphenateCapitalizedWords bool If true, allows hyphenation of capitalized words. read-write
hyphenateLadderLimit number The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero. read-write
hyphenateLastWord bool If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true. read-write
hyphenateWordsLongerThan number The minimum number of letters a word must have in order to qualify for hyphenation. read-write
hyphenation bool If true, allows hyphenation. read-write
hyphenationZone Measurement Unit (Number or String)=any The amount of white space allowed at the end of a line of non-justified text before hypenation begins. Note: Valid when composer is single-line composer. read-write
ignoreEdgeAlignment bool If true, ignores optical edge alignment for the paragraph. read-write
index number The index of the text in the collection or parent object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
jidori number The number of grid squares in which to arrange the text. read-write
justification Justification The paragraph alignment. read-write
kashidas KashidasOptions Use of Kashidas for justification read-write
keepAllLinesTogether bool If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns. read-write
keepFirstLines number The minimum number of lines to keep together in a paragraph before allowing a page break. read-write
keepLastLines number The minimum number of lines to keep together in a paragraph after a page break. read-write
keepLinesTogether bool If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames. read-write
keepRuleAboveInFrame bool If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true. read-write
keepWithNext number The minimum number of lines to keep with the next paragraph. read-write
keepWithPrevious bool If the first line in the paragraph should be kept with the last line of previous paragraph. read-write
kentenAlignment KentenAlignment The alignment of kenten characters relative to the parent characters. read-write
kentenCharacterSet KentenCharacterSet The character set used for the custom kenten character. Note: Valid only when kenten kind is custom. read-write
kentenCustomCharacter string The character used for kenten. Note: Valid only when kenten kind is custom. read-write
kentenFillColor The swatch (color, gradient, tint, or mixed ink) applied to the fill of kenten characters. Can return: Swatch or String. read-write
kentenFont The font to use for kenten characters. Can return: Font or String. read-write
kentenFontSize number The size (in points) of kenten characters. read-write
kentenFontStyle The font style of kenten characters. Can return: String or NothingEnum enumerator. read-write
kentenKind KentenCharacter The style of kenten characters. read-write
kentenOverprintFill AdornmentOverprint The method of overprinting the kenten fill. read-write
kentenOverprintStroke AdornmentOverprint The method of overprinting the kenten stroke. read-write
kentenPlacement number The distance between kenten characters and their parent characters. read-write
kentenPosition RubyKentenPosition The kenten position relative to the parent character. read-write
kentenStrokeColor The swatch (color, gradient, tint, or mixed ink) applied to the stroke of kenten characters. Can return: Swatch or String. read-write
kentenStrokeTint number The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) read-write
kentenTint number The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) read-write
kentenWeight number The stroke weight (in points) of kenten characters. read-write
kentenXScale number The horizontal size of kenten characters as a percent of the original size. read-write
kentenYScale number The vertical size of kenten charachers as a percent of the original size. read-write
kerningMethod string The type of pair kerning. read-write
kerningValue number The amount of space to add or remove between characters, specified in thousands of an em. read-write
keyboardDirection CharacterDirectionOptions The keyboard direction of the character. read-write
kinsokuHangType KinsokuHangTypes The type of hanging punctuation to allow. Note: Valid only when a kinsoku set is in effect. read-write
kinsokuSet The kinsoku set that determines legitimate line breaks. Can return: KinsokuTable, KinsokuSet enumerator or String. read-write
kinsokuType KinsokuType The type of kinsoku processing for preventing kinsoku characters from beginning or ending a line. Note: Valid only when a kinsoku set is defined. read-write
lastLineIndent Measurement Unit (Number or String)=any The amount to indent the last line in the paragraph. read-write
leading The leading applied to the text. Can return: Unit or Leading enumerator. read-write
leadingAki number The amount of space before each character. read-write
leadingModel LeadingModel The point from which leading is measured from line to line. read-write
leftIndent Measurement Unit (Number or String)=any The width of the left indent. read-write
length number The number of objects in the collection. read-only
ligatures bool If true, replaces specific character combinations (e.g., fl, fi) with ligature characters. read-write
lines Lines A collection of lines. read-only
listBoxes ListBoxes A collection of listboxes. read-only
maximumGlyphScaling number The maximum width (as a percentage) of individual characters. (Range: 50 to 200) read-write
maximumLetterSpacing number 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. read-write
maximumWordSpacing number The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000) read-write
minimumGlyphScaling number The minimum width (as a percentage) of individual characters. (Range: 50 to 200) read-write
minimumLetterSpacing number 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. read-write
minimumWordSpacing number 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) read-write
miterLimit = 4 number The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. read-write
mojikumi The mojikumi table. For information, see mojikumi table defaults. Can return: MojikumiTable, String or MojikumiTableDefaults enumerator. read-write
multiStateObjects MultiStateObjects A collection of multi-state objects. read-only
nestedGrepStyles NestedGrepStyles A collection of nested GREP styles. read-only
nestedLineStyles NestedLineStyles A collection of nested line styles. read-only
nestedStyles NestedStyles A collection of nested styles. read-only
noBreak bool If true, keeps the text on the same line. read-write
notes Notes A collection of notes. read-only
numberingAlignment ListAlignment The alignment of the number. read-write
numberingApplyRestartPolicy bool If true, apply the numbering restart policy. read-write
numberingCharacterStyle The character style to be used for the number string. Can return: CharacterStyle or String. read-write
numberingContinue bool Continue the numbering at this level. read-write
numberingExpression string The number string expression for numbering. read-write
numberingFormat Numbering format options. Can return: NumberingStyle enumerator or String. read-write
numberingLevel number The level of the paragraph. read-write
numberingRestartPolicies NumberingRestartPolicy Numbering restart policies. read-only
numberingResultNumber number The current level number value. read-only
numberingStartAt number Determines starting number in a numbered list. read-write
opentypeFeatures OpenType features. Can return: Array of Array of 2 Strings or Long Integers. read-write
otfContextualAlternate bool If true, uses contextual alternate forms in OpenType fonts. read-write
otfDiscretionaryLigature bool If true, uses discretionary ligatures in OpenType fonts. read-write
otfFigureStyle OTFFigureStyle The figure style in OpenType fonts. read-write
otfFraction bool If true, uses fractions in OpenType fonts. read-write
otfHVKana bool If true, switches hiragana fonts, which have different glyphs for horizontal and vertical. read-write
otfHistorical bool If true, use historical forms in OpenType fonts. read-write
otfJustificationAlternate bool If true, use alternate justification forms in OpenType fonts read-write
otfLocale bool If true, uses localized forms in OpenType fonts. read-write
otfMark bool If true, uses mark positioning in OpenType fonts. read-write
otfOrdinal bool If true, uses ordinals in OpenType fonts. read-write
otfOverlapSwash bool If true, use overlapping swash forms in OpenType fonts read-write
otfProportionalMetrics bool If true, kerns according to proportional CJK metrics in OpenType fonts. read-write
otfRomanItalics bool If true, applies italics to half-width alphanumerics. read-write
otfSlashedZero bool If true, use a slashed zeroes in OpenType fonts. read-write
otfStretchedAlternate bool If true, use stretched alternate forms in OpenType fonts read-write
otfStylisticAlternate bool If true, use stylistic alternate forms in OpenType fonts read-write
otfStylisticSets number The stylistic sets to use in OpenType fonts. read-write
otfSwash bool If true, uses swash forms in OpenType fonts. read-write
otfTitling bool If true, uses titling forms in OpenType fonts. read-write
ovals Ovals A collection of ellipses. read-only
overprintFill bool If true, the fill color of the characters will overprint. read-write
overprintStroke bool If true, the stroke of the characters will overprint. read-write
pageItems PageItems The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. read-only
paragraphBorderBottomLeftCornerOption CornerOptions The shape to apply to the bottom left corner of rectangular shapes. read-write
paragraphBorderBottomLeftCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes read-write
paragraphBorderBottomLineWeight Measurement Unit (Number or String)=any The bottom line weight of the border of paragraph. read-write
paragraphBorderBottomOffset Measurement Unit (Number or String)=any The distance to offset the bottom edge of the paragraph border. read-write
paragraphBorderBottomOrigin ParagraphBorderBottomOriginEnum The basis (descent or baseline) used to calculate the bottom origin of the paragraph border. read-write
paragraphBorderBottomRightCornerOption CornerOptions The shape to apply to the bottom right corner of rectangular shapes. read-write
paragraphBorderBottomRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes read-write
paragraphBorderColor The swatch (color, gradient, tint, or mixed ink) applied to the paragraph stroke. Can return: Swatch or String. read-write
paragraphBorderDisplayIfSplits bool If true, then paragraph border is also displayed at the points where the paragraph splits across frames or columns. read-write
paragraphBorderGapColor The swatch (color, gradient, tint, or mixed ink) applied to the paragraph border gap. Note: Valid only when the border type is not solid. Can return: Swatch or String. read-write
paragraphBorderGapOverprint bool If true, the paragraph border gap will overprint. Note: Valid only when border type is not solid. read-write
paragraphBorderGapTint number The tint (as a percentage) of the paragraph border gap. Note: Valid only when the border type is not solid. (Range: 0 to 100) read-write
paragraphBorderLeftLineWeight Measurement Unit (Number or String)=any The left line weight of the border of paragraph. read-write
paragraphBorderLeftOffset Measurement Unit (Number or String)=any The distance to offset the left edge of the paragraph border. read-write
paragraphBorderOn bool If true, the paragraph border is on. read-write
paragraphBorderOverprint bool If true, the paragraph border will overprint. read-write
paragraphBorderRightLineWeight Measurement Unit (Number or String)=any The right line weight of the border of paragraph. read-write
paragraphBorderRightOffset Measurement Unit (Number or String)=any The distance to offset the right edge of the paragraph border. read-write
paragraphBorderStrokeEndCap EndCap The end shape of an open path. read-write
paragraphBorderStrokeEndJoin EndJoin The corner join applied to the Paragraph. read-write
paragraphBorderTint number The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) read-write
paragraphBorderTopLeftCornerOption CornerOptions The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. read-write
paragraphBorderTopLeftCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes read-write
paragraphBorderTopLineWeight Measurement Unit (Number or String)=any The top line weight of the border of paragraph. read-write
paragraphBorderTopOffset Measurement Unit (Number or String)=any The distance to offset the top edge of the paragraph border. read-write
paragraphBorderTopOrigin ParagraphBorderTopOriginEnum The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph border. read-write
paragraphBorderTopRightCornerOption CornerOptions The shape to apply to the top right corner of rectangular shapes read-write
paragraphBorderTopRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes read-write
paragraphBorderType The type of the border for the paragraph. Can return: StrokeStyle or String. read-write
paragraphBorderWidth ParagraphBorderEnum The basis (text width or column width) used to calculate the width of the paragraph border. read-write
paragraphDirection ParagraphDirectionOptions Paragraph direction. read-write
paragraphGyoudori bool If true, the gyoudori mode applies to the entire paragraph. If false, the gyoudori mode applies to each line in the paragraph. read-write
paragraphJustification ParagraphJustificationOptions Paragraph justification. read-write
paragraphKashidaWidth number Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long read-write
paragraphShadingBottomLeftCornerOption CornerOptions The shape to apply to the bottom left corner of rectangular shapes. read-write
paragraphShadingBottomLeftCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes read-write
paragraphShadingBottomOffset Measurement Unit (Number or String)=any The distance to offset the bottom edge of the paragraph. read-write
paragraphShadingBottomOrigin ParagraphShadingBottomOriginEnum The basis (descent or baseline) used to calculate the bottom origin of the paragraph shading. read-write
paragraphShadingBottomRightCornerOption CornerOptions The shape to apply to the bottom right corner of rectangular shapes. read-write
paragraphShadingBottomRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes read-write
paragraphShadingClipToFrame bool If true, forces the shading of the paragraph to be clipped with respect to frame shape. read-write
paragraphShadingColor The swatch (color, gradient, tint, or mixed ink) applied to the paragraph shading. Can return: Swatch or String. read-write
paragraphShadingLeftOffset Measurement Unit (Number or String)=any The distance to offset the left edge of the paragraph. read-write
paragraphShadingOn bool If true, the paragraph shading is On. read-write
paragraphShadingOverprint bool If true, the paragraph shading will overprint. read-write
paragraphShadingRightOffset Measurement Unit (Number or String)=any The distance to offset the right edge of the paragraph. read-write
paragraphShadingSuppressPrinting bool If true, suppress printing of the shading of the paragraph. read-write
paragraphShadingTint number The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) read-write
paragraphShadingTopLeftCornerOption CornerOptions The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. read-write
paragraphShadingTopLeftCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes read-write
paragraphShadingTopOffset Measurement Unit (Number or String)=any The distance to offset the top edge of the paragraph. read-write
paragraphShadingTopOrigin ParagraphShadingTopOriginEnum The basis (cap height, ascent or baseline) used to calculate the top origin of the paragraph shading. read-write
paragraphShadingTopRightCornerOption CornerOptions The shape to apply to the top right corner of rectangular shapes read-write
paragraphShadingTopRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes read-write
paragraphShadingWidth ParagraphShadingWidthEnum The basis (text width or column width) used to calculate the width of the paragraph shading. read-write
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the Paragraph (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, Change or HiddenText). read-only
parentStory Story The story that contains the text. read-only
parentTextFrames An array of the text frames that contain the text. Can return: Array of TextFrames or TextPaths. read-only
pointSize Measurement Unit (Number or String)=any The text size. read-write
polygons Polygons A collection of polygons. read-only
position Position The text position relative to the baseline. read-write
positionalForm PositionalForms The OpenType positional form. read-write
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write
providerHyphenationStyle HyphenationStyleEnum The hyphenation style chosen for the provider. read-write
radioButtons RadioButtons A collection of radio buttons. read-only
rectangles Rectangles A collection of rectangles. read-only
rensuuji bool If true, disallows line breaks in numbers. If false, lines can break between digits in multi-digit numbers. read-write
rightIndent Measurement Unit (Number or String)=any The width of the right indent. read-write
rotateSingleByteCharacters bool If true, rotates Roman characters in vertical text. read-write
rubyAlignment RubyAlignments The ruby alignment. read-write
rubyAutoAlign bool If true, auto aligns ruby. read-write
rubyAutoScaling bool If true, automatically scales ruby to the specified percent of parent text size. For information on specifying a percent, see ruby parent scaling percent. read-write
rubyAutoTcyAutoScale bool If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to fit one em. read-write
rubyAutoTcyDigits number The number of digits included in auto tcy (tate-chuu-yoko) in ruby. read-write
rubyAutoTcyIncludeRoman bool If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. read-write
rubyFill The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby characters. Can return: Swatch or String. read-write
rubyFlag bool If true, ruby is on. read-write
rubyFont The font applied to ruby characters. Can return: Font or String. read-write
rubyFontSize number The size (in points) of ruby characters. read-write
rubyFontStyle The font style of ruby characters. Can return: String or NothingEnum enumerator. read-write
rubyOpenTypePro bool If true, uses OpenType Pro fonts for ruby. read-write
rubyOverhang bool If true, constrains ruby overhang to the specified amount. For information on specifying an amount, see ruby parent overhang amount. read-write
rubyOverprintFill AdornmentOverprint The method of overprinting the ruby fill. read-write
rubyOverprintStroke AdornmentOverprint The method of overprinting the ruby stroke. read-write
rubyParentOverhangAmount RubyOverhang The amount by which ruby characters can overhang the parent text. read-write
rubyParentScalingPercent number The amount (as a percentage) to scale the parent text size to determine the ruby text size. read-write
rubyParentSpacing RubyParentSpacing The ruby spacing relative to the parent text. read-write
rubyPosition RubyKentenPosition The position of ruby characters relative to the parent text. read-write
rubyString string The ruby string contents. read-write
rubyStroke The swatch (color, gradient, tint, or mixed ink) applied to the stroke of ruby characters. Can return: Swatch or String. read-write
rubyStrokeTint number The stroke tint (as a percentage) of ruby characters. read-write
rubyTint number The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) read-write
rubyType RubyTypes The ruby type. read-write
rubyWeight number The stroke weight (in points) of ruby characters. read-write
rubyXOffset number The amount of horizontal space between ruby and parent characters. read-write
rubyXScale number The horizontal size of ruby characters, specified as a percent of the original size. read-write
rubyYOffset number The amount of vertical space between ruby and parent characters. read-write
rubyYScale number The vertical size of ruby characters, specified as a percent of the original size. read-write
ruleAbove bool If true, places a rule above the paragraph. read-write
ruleAboveColor The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String. read-write
ruleAboveGapColor The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String. read-write
ruleAboveGapOverprint bool If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid. read-write
ruleAboveGapTint number The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid. read-write
ruleAboveLeftIndent Measurement Unit (Number or String)=any The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph. read-write
ruleAboveLineWeight Measurement Unit (Number or String)=any The line weight of the rule above. read-write
ruleAboveOffset Measurement Unit (Number or String)=any The amount to offset the paragraph rule above from the baseline of the first line the paragraph. read-write
ruleAboveOverprint bool If true, the paragraph rule above will overprint. read-write
ruleAboveRightIndent Measurement Unit (Number or String)=any 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. read-write
ruleAboveTint number The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) read-write
ruleAboveType The stroke type of the rule above the paragraph. Can return: StrokeStyle or String. read-write
ruleAboveWidth RuleWidth The basis (text width or column width) used to calculate the width of the paragraph rule above. read-write
ruleBelow bool If true, applies a paragraph rule below. read-write
ruleBelowColor The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String. read-write
ruleBelowGapColor The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String. read-write
ruleBelowGapOverprint bool If true, the gap color of the rule below will overprint. read-write
ruleBelowGapTint number The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid. read-write
ruleBelowLeftIndent Measurement Unit (Number or String)=any The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph. read-write
ruleBelowLineWeight Measurement Unit (Number or String)=any The line weight of the rule below. read-write
ruleBelowOffset Measurement Unit (Number or String)=any The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph. read-write
ruleBelowOverprint bool If true, the rule below will overprint. read-write
ruleBelowRightIndent Measurement Unit (Number or String)=any 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. read-write
ruleBelowTint number The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) read-write
ruleBelowType The stroke type of the rule below the paragraph. Can return: StrokeStyle or String. read-write
ruleBelowWidth RuleWidth The basis (text width or column width) used to calculate the width of the paragraph rule below. read-write
scaleAffectsLineHeight bool If true, the line changes size when characters are scaled. read-write
shataiAdjustRotation bool If true, applies shatai rotation. read-write
shataiAdjustTsume bool If true, adjusts shatai tsume. read-write
shataiDegreeAngle number The shatai lens angle (in degrees). read-write
shataiMagnification number The amount (as a percentage) of shatai obliquing to apply. read-write
signatureFields SignatureFields A collection of signature fields. read-only
singleWordJustification SingleWordJustification The alignment to use for lines that contain a single word. read-write
skew number The skew angle of the Paragraph. read-write
spaceAfter Measurement Unit (Number or String)=any The height of the paragraph space below. read-write
spaceBefore Measurement Unit (Number or String)=any The height of the paragraph space above. read-write
spanColumnMinSpaceAfter Measurement Unit (Number or String)=any The minimum space after a span or a split column read-write
spanColumnMinSpaceBefore Measurement Unit (Number or String)=any The minimum space before a span or a split column read-write
spanColumnType SpanColumnTypeOptions Whether a paragraph should be a single column, span columns or split columns read-write
spanSplitColumnCount The number of columns a paragraph spans or the number of split columns. Can return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. read-write
splineItems SplineItems The spline items collection. read-only
splitColumnInsideGutter Measurement Unit (Number or String)=any The inside gutter if the paragraph splits columns read-write
splitColumnOutsideGutter Measurement Unit (Number or String)=any The outside gutter if the paragraph splits columns read-write
startParagraph StartParagraph The location at which to start the paragraph. read-write
strikeThroughColor The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String. read-write
strikeThroughGapColor The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String. read-write
strikeThroughGapOverprint bool If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid. read-write
strikeThroughGapTint number The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid. read-write
strikeThroughOffset Measurement Unit (Number or String)=any The amount by which to offset the strikethrough stroke from the text baseline. read-write
strikeThroughOverprint bool If true, the strikethrough stroke will overprint. read-write
strikeThroughTint number The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) read-write
strikeThroughType The stroke type of the strikethrough stroke. Can return: StrokeStyle or String. read-write
strikeThroughWeight Measurement Unit (Number or String)=any The stroke weight of the strikethrough stroke. read-write
strikeThru bool If true, draws a strikethrough line through the text. read-write
strokeAlignment TextStrokeAlign The stroke alignment applied to the text. read-write
strokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Paragraph. Can also accept: String. read-write
strokeTint number The tint (as a percentage) of the stroke color of the Paragraph. (To specify a tint percentage, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) read-write
strokeWeight Measurement Unit (Number or String)=any The stroke weight applied to the characters of the text. read-write
styleOverridden bool If true, the applied style has been overridden with additional attributes. read-only
tabList A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs. read-write
tabStops TabStops A collection of tab stops. read-only
tables Tables A collection of tables. read-only
tatechuyoko bool If true, makes the character horizontal in vertical text. read-write
tatechuyokoXOffset number The horizontal offset for horizontal characters in vertical text. read-write
tatechuyokoYOffset number The vertical offset for horizontal characters in vertical text. read-write
textBoxes TextBoxes A collection of text boxes. read-only
textColumns TextColumns A collection of text columns. read-only
textFrames TextFrames A collection of text frames. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
texts Texts A collection of text objects. read-only
tracking number The amount by which to loosen or tighten a block of text, specified in thousands of an em. read-write
trailingAki number The amount of space after each character. read-write
treatIdeographicSpaceAsSpace bool If true, ideographic spaces will not wrap to the next line like text characters. read-write
tsume number The amount of horizontal character compression. read-write
underline bool If true, underlines the text. read-write
underlineColor The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String. read-write
underlineGapColor The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch or String. read-write
underlineGapOverprint bool If true, the gap color of the underline stroke will overprint. read-write
underlineGapTint number The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid. read-write
underlineOffset Measurement Unit (Number or String)=any The amount by which to offset the underline from the text baseline. read-write
underlineOverprint bool If true, the underline stroke color will overprint. read-write
underlineTint number The underline stroke tint (as a percentage). (Range: 0 to 100) read-write
underlineType The stroke type of the underline stroke. Can return: StrokeStyle or String. read-write
underlineWeight Measurement Unit (Number or String)=any The stroke weight of the underline stroke. read-write
verticalScale number The vertical scaling applied to the Paragraph. read-write
warichu bool If true, turns on warichu. read-write
warichuAlignment WarichuAlignment The warichu alignment. read-write
warichuCharsAfterBreak number The minimum number of characters allowed after a line break. read-write
warichuCharsBeforeBreak number The minimum number of characters allowed before a line break. read-write
warichuLineSpacing number The gap between lines of warichu characters. read-write
warichuLines number The number of lines of warichu within a single normal line. read-write
warichuSize number The amount (as a percentage) to scale parent text size to determine warichu size. read-write
words Words A collection of words. read-only
xOffsetDiacritic number The x (horizontal) offset for diacritic adjustment. read-write
yOffsetDiacritic number The y (vertical) offset for diacritic adjustment. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
applyCharacterStyle(
using)
applyConditions(
using ​[, removeExisting])
applyParagraphStyle(
using ​[, clearingOverrides])
asynchronousExportFile(
format, to ​[, showingOptions] ​[, using] ​[, versionComments] ​[, forceSave])
  → BackgroundTask
autoTag(
)
changeGlyph(
[reverseOrder])
  → Text
changeGrep(
[reverseOrder])
  → Text
changeText(
[reverseOrder])
  → Text
changeTransliterate(
[reverseOrder])
  → Text
changecase(
using)
clearOverrides(
[overridesToClear])
convertBulletsAndNumberingToText(
)
convertToNote(
)
  → Note
convertToTable(
[columnSeparator] ​[, rowSeparator] ​[, numberOfColumns])
  → Table
createEmailQRCode(
[emailAddress] ​[, subject] ​[, body], qrCodeSwatch ​[, withProperties])
createHyperlinkQRCode(
[urlLink], qrCodeSwatch ​[, withProperties])
createOutlines(
[deleteOriginal])
  → PageItem
createPlainTextQRCode(
[plainText], qrCodeSwatch ​[, withProperties])
createStyleThumbnailWithProperties(
previewText, pointSize, space, colorValue, to, charOrParaStyle)
  → bool
createTextMsgQRCode(
[cellNumber] ​[, textMessage], qrCodeSwatch ​[, withProperties])
createThumbnailWithProperties(
previewText, pointSize, space, colorValue, to)
  → bool
createVCardQRCode(
[firstName] ​[, lastName] ​[, jobTitle] ​[, cellPhone] ​[, phone] ​[, email] ​[, organisation] ​[, streetAddress] ​[, city] ​[, adrState] ​[, country] ​[, postalCode] ​[, website], qrCodeSwatch ​[, withProperties])
duplicate(
to, reference)
  → Text
exportFile(
format, to ​[, showingOptions] ​[, using] ​[, versionComments] ​[, forceSave])
findGlyph(
[reverseOrder])
  → Text
findGrep(
[reverseOrder])
  → Text
findHyperlinks(
[sortOrder])
  → HyperlinkTextSource
findText(
[reverseOrder])
  → Text
findTransliterate(
[reverseOrder])
  → Text
getElements(
)
  → Paragraph
markup(
using)
move(
to, reference)
  → Text
place(
fileName ​[, showingOptions] ​[, withProperties])
recompose(
)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
showText(
)
textHasOverrides(
charOrParaStyle ​[, charStyleAsOverride])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
applyCharacterStyle(
using)
Apply a character style.
using CharacterStyle The character style to apply.
applyConditions(
using ​[, removeExisting=false])
Apply one or more conditions.
using Array<Condition> The condition(s) to apply
removeExisting bool If true, remove existing conditions. (Optional)
applyParagraphStyle(
using ​[, clearingOverrides=true])
Apply a paragraph style.
using ParagraphStyle The paragraph style to apply.
clearingOverrides bool If true, clear any text attributes before applying the style. (Optional)
asynchronousExportFile(
format, to ​[, showingOptions=false] ​[, using] ​[, versionComments] ​[, forceSave=false])
  → BackgroundTask
asynchronously exports the object(s) to a file.
format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to File The path to the export file.
showingOptions bool If true, displays the export options dialog. (Optional)
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
autoTag(
)
Tag the object or the parent story using default tags defined in XML preference.
changeGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeText(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value and replaces the text with the change character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changecase(
using)
Sets the case of the text.
using ChangecaseMode The text case option.
clearOverrides(
[overridesToClear=OverrideType.ALL])
Clears the specified types of override.
overridesToClear OverrideType The types of override to clear. (Optional)
convertBulletsAndNumberingToText(
)
Convert bullets and numbering to text.
convertToNote(
)
  → Note
Converts the text to a note.
convertToTable(
[columnSeparator] ​[, rowSeparator] ​[, numberOfColumns=1])
  → Table
Converts the text to a table.
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)
createEmailQRCode(
[emailAddress] ​[, subject] ​[, body], qrCodeSwatch ​[, withProperties])
Create Email QR Code on the page item or document
emailAddress string QR code Email Address (Optional)
subject string QR code Email Subject (Optional)
body string QR code Email Body Message (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional)
createHyperlinkQRCode(
[urlLink], qrCodeSwatch ​[, withProperties])
Create Hyperlink QR Code on the page item or document
urlLink string QR code Hyperlink URL (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional)
createOutlines(
[deleteOriginal=true])
  → PageItem
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.
deleteOriginal bool If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)
createPlainTextQRCode(
[plainText], qrCodeSwatch ​[, withProperties])
Create Plain Text QR Code on the page item
plainText string QR code Plain Text (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional)
createStyleThumbnailWithProperties(
previewText, pointSize, space, colorValue, to, charOrParaStyle)
  → bool
Create thumbnail for selected text using the applied style and overrides with the given properties.
previewText string Text to use as sample
pointSize number Text font size (in points)
space ColorSpace Color space RGB, CMYK or LAB
colorValue Array<number> Color values
to File The path to the export file.
charOrParaStyle StyleType The applied style type to use.
createTextMsgQRCode(
[cellNumber] ​[, textMessage], qrCodeSwatch ​[, withProperties])
Create Text Msg QR Code on the page item or document
cellNumber string QR code Text Phone Number (Optional)
textMessage string QR code Text Message (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional)
createThumbnailWithProperties(
previewText, pointSize, space, colorValue, to)
  → bool
Create thumbnail for selected text with the given properties.
previewText string Text to use as sample
pointSize number Text font size (in points)
space ColorSpace Color space RGB, CMYK or LAB
colorValue Array<number> Color values
to File The path to the export file.
createVCardQRCode(
[firstName] ​[, lastName] ​[, jobTitle] ​[, cellPhone] ​[, phone] ​[, email] ​[, organisation] ​[, streetAddress] ​[, city] ​[, adrState] ​[, country] ​[, postalCode] ​[, website], qrCodeSwatch ​[, withProperties])
Create Business Card QR Code on the page item or load on document's placegun
firstName string QR code Business Card First Name (Optional)
lastName string QR code Business Card Last Name (Optional)
jobTitle string QR code Business Card Title (Optional)
cellPhone string QR code Business Card Cell Phone Number (Optional)
phone string QR code Business Card Phone Number (Optional)
email string QR code Business Card Email Address (Optional)
organisation string QR code Business Card Organisation (Optional)
streetAddress string QR code Business Card Street Address (Optional)
city string QR code Business Card City (Optional)
adrState string QR code Business Card State (Optional)
country string QR code Business Card Country (Optional)
postalCode string QR code Business Card Postal Code (Optional)
website string QR code Business Card URL (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional)
duplicate(
to, reference)
  → Text
Duplicates the text in the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)
exportFile(
format, to ​[, showingOptions=false] ​[, using] ​[, versionComments] ​[, forceSave=false])
Exports the object(s) to a file.
format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to File The path to the export file.
showingOptions bool If true, displays the export options dialog. (Optional)
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
findGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findHyperlinks(
[sortOrder])
  → HyperlinkTextSource
Finds hyperlink sources that intersecting with specified text range.
sortOrder RangeSortOrder The sort order of found ranges. (Optional)
findText(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
getElements(
)
  → Paragraph
Resolves the object specifier, creating an array of object references.
markup(
using)
Associates the page item with the specified XML element while preserving existing content.
using XMLElement The XML element.
move(
to, reference)
  → Text
Moves the text to the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional)
place(
fileName ​[, showingOptions=false] ​[, withProperties])
Places the file.
fileName File The file to place
showingOptions bool Whether to display the import options dialog (Optional)
withProperties Object Initial values for properties of the placed object(s) (Optional)
recompose(
)
Recomposes the text in the Paragraph.
remove(
)
Deletes the Paragraph.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the Paragraph in relation to previously selected objects. (Optional)
showText(
)
Jump to the text range.
textHasOverrides(
charOrParaStyle ​[, charStyleAsOverride=true])
  → bool
If true, text has local overrides
charOrParaStyle StyleType Style type to look at.
charStyleAsOverride bool Whether to consider character styles as overrides or not (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Paragraph.
toSpecifier(
)
  → string
Retrieves the object specifier.