ParagraphStyle

A paragraph style.

Go to Property Listing | Method Listing

Methods:

convertBulletsAndNumberingToText, duplicate, extractLabel, getElements, insertLabel, move, remove, toSource, toSpecifier

Property Listing

Property	Type	Access	Description
alignToBaseline	Boolean	read/write	If true, aligns the baseline of the text to the baseline grid.
appliedFont	Font String	read/write	The font applied to the ParagraphStyle, specified as either a font object or the name of font family. Can return: Font or String.
appliedLanguage	LanguageWithVendors LanguageCanalsoaccept:String	read/write	The language of the text. Can return: LanguageWithVendors or Language. Can also accept: String.
appliedNumberingList	NumberingList String	read/write	The list to be part of. Can return: NumberingList or String.
autoLeading	Number (range 0 - 500)	read/write	The percent of the type size to use for auto leading. (Range: 0 to 500).
balanceRaggedLines	Boolean BalanceLinesStyle BalanceLinesStyle.FULLY_BALANCED BalanceLinesStyle.NO_BALANCING BalanceLinesStyle.PYRAMID_SHAPE BalanceLinesStyle.VEE_SHAPE	read/write	If true or set to an enumeration value, balances ragged lines. Note: Not valid with a single-line text composer. Can return: Boolean or BalanceLinesStyle enumerator.
basedOn	ParagraphStyle String	read/write	The style that this style is based on. Can return: ParagraphStyle or String.
baselineShift	Number String	read/write	The baseline shift applied to the text.
bulletChar	Bullet	readonly	Bullet character.
bulletsAlignment	ListAlignment ListAlignment.CENTER_ALIGN ListAlignment.LEFT_ALIGN ListAlignment.RIGHT_ALIGN	read/write	The alignment of the bullet character.
bulletsAndNumberingListType	ListType ListType.BULLET_LIST ListType.NO_LIST ListType.NUMBERED_LIST	read/write	List type for bullets and numbering.
bulletsCharacterStyle	CharacterStyle String	read/write	The character style to be used for the text after string. Can return: CharacterStyle or String.
bulletsTextAfter	String	read/write	The text after string expression for bullets.
capitalization	Capitalization Capitalization.ALL_CAPS Capitalization.CAP_TO_SMALL_CAP Capitalization.NORMAL Capitalization.SMALL_CAPS	read/write	The capitalization scheme.
composer	String	read/write	The text composer to use to compose the text.
desiredGlyphScaling	Number (range 50 - 200)	read/write	The desired width (as a percentage) of individual characters. (Range: 50 to 200)
desiredLetterSpacing	Number	read/write	The desired letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500)
desiredWordSpacing	Number (range 0 - 1000)	read/write	The desired word spacing, specified as a percentage of the font word space value. (Range: 0 to 1000)
dropCapCharacters	Number (range 0 - 150)	read/write	The number of characters to drop cap.
dropCapLines	Number (range 0 - 25)	read/write	The number of lines to drop cap.
dropCapStyle	CharacterStyle String	read/write	The character style to apply to the drop cap. Can also accept: String.
dropcapDetail	Number	read/write	Details about the drop cap based on the glyph outlines. 1 = left side bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ParagraphStyle. . Can also accept: String.
fillTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the fill color of the ParagraphStyle. (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	Number String	read/write	The amount to indent the first line.
fontStyle	String	read/write	The name of the font style.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the text. (Range: -180 to 180)
gradientFillLength	Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the text.
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the text, in the format [x, y].
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the text. (Range: -180 to 180)
gradientStrokeLength	Number	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the text.
gradientStrokeStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the text, in the format [x, y].
gridAlignFirstLineOnly	Boolean	read/write	If true, aligns only the first line to the frame grid or baseline grid. If false, aligns all lines to the grid.
horizontalScale	Number	read/write	The horizontal scaling applied to the ParagraphStyle.
hyphenWeight	Number (range 0 - 10)	read/write	The relative desirability of better spacing vs. fewer hyphens. A lower value results in greater use of hyphens. (Range: 0 to 100)
hyphenateAcrossColumns	Boolean	read/write	If true, allows the last word in a text column to be hyphenated.
hyphenateAfterFirst	Number (range 1 - 15)	read/write	The mininum number of letters at the beginning of a word that can be broken by a hyphen.
hyphenateBeforeLast	Number (range 1 - 15)	read/write	The minimum number of letters at the end of a word that can be broken by a hyphen.
hyphenateCapitalizedWords	Boolean	read/write	If true, allows hyphenation of capitalized words.
hyphenateLadderLimit	Number (range 0 - 25)	read/write	The maximum number of hyphens that can appear on consecutive lines. To specify unlimited consecutive lines, use zero.
hyphenateLastWord	Boolean	read/write	If true, allows hyphenation in the last word in a paragraph. Note: Valid only when hyphenation is true.
hyphenateWordsLongerThan	Number (range 3 - 25)	read/write	The minimum number of letters a word must have in order to qualify for hyphenation.
hyphenation	Boolean	read/write	If true, allows hyphenation.
hyphenationZone	Number String	read/write	The amount of white space allowed at the end of a line of non-justified text before hypenation begins. Note: Valid when composer is single-line composer.
id	Number	readonly	The unique ID of the ParagraphStyle.
ignoreEdgeAlignment	Boolean	read/write	If true, ignores optical edge alignment for the paragraph.
imported	Boolean	readonly	If true, the style was imported from another document.
index	Number	readonly	The index of the ParagraphStyle within its containing object.
justification	Justification Justification.AWAY_FROM_BINDING_SIDE Justification.CENTER_ALIGN Justification.CENTER_JUSTIFIED Justification.FULLY_JUSTIFIED Justification.LEFT_ALIGN Justification.LEFT_JUSTIFIED Justification.RIGHT_ALIGN Justification.RIGHT_JUSTIFIED Justification.TO_BINDING_SIDE	read/write	The paragraph alignment.
keepAllLinesTogether	Boolean	read/write	If true, keeps all lines of the paragraph together. If false, allows paragraphs to break across pages or columns.
keepFirstLines	Number (range 1 - 50)	read/write	The minimum number of lines to keep together in a paragraph before allowing a page break.
keepLastLines	Number (range 1 - 50)	read/write	The minimum number of lines to keep together in a paragraph after a page break.
keepLinesTogether	Boolean	read/write	If true, keeps a specified number of lines together when the paragraph breaks across columns or text frames.
keepRuleAboveInFrame	Boolean	read/write	If true, forces the rule above the paragraph to remain in the frame bounds. Note: Valid only when rule above is true.
keepWithNext	Number (range 0 - 5)	read/write	The minimum number of lines to keep with the next paragraph.
kerningMethod	String	read/write	The type of pair kerning.
label	String	read/write	A property that can be set to any string.
lastLineIndent	Number String	read/write	The amount to indent the last line in the paragraph.
leading	Unit Leading Leading.AUTO	read/write	The leading applied to the text. Can return: Unit or Leading enumerator.
leftIndent	Number String	read/write	The width of the left indent.
ligatures	Boolean	read/write	If true, replaces specific character combinations (e.g., fl, fi) with ligature characters.
maximumGlyphScaling	Number (range 50 - 200)	read/write	The maximum width (as a percentage) of individual characters. (Range: 50 to 200)
maximumLetterSpacing	Number	read/write	The maximum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.
maximumWordSpacing	Number (range 0 - 1000)	read/write	The maximum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
minimumGlyphScaling	Number (range 50 - 200)	read/write	The minimum width (as a percentage) of individual characters. (Range: 50 to 200)
minimumLetterSpacing	Number	read/write	The minimum letter spacing, specified as a percentge of the built-in space between letters in the font. (Range: -100 to 500) Note: Valid only when text is justified.
minimumWordSpacing	Number (range 0 - 1000)	read/write	The minimum word spacing, specified as a percentage of the font word space value. Note: Valid only when text is justified. (Range: 0 to 1000)
name	String	read/write	The name of the ParagraphStyle.
nestedStyles	NestedStyles NestedStyle	readonly	A collection of nested styles.
nextStyle	ParagraphStyle	read/write	The style to apply to new paragraphs that follow paragraphs tagged with this style.
noBreak	Boolean	read/write	If true, keeps the text on the same line.
numberingAlignment	ListAlignment ListAlignment.CENTER_ALIGN ListAlignment.LEFT_ALIGN ListAlignment.RIGHT_ALIGN	read/write	The alignment of the number.
numberingApplyRestartPolicy	Boolean	read/write	If true, apply the numbering restart policy.
numberingCharacterStyle	CharacterStyle String	read/write	The character style to be used for the number string. Can return: CharacterStyle or String.
numberingContinue	Boolean	read/write	Continue the numbering at this level.
numberingExpression	String	read/write	The number string expression for numbering.
numberingFormat	NumberingStyle NumberingStyle.ARABIC NumberingStyle.FORMAT_NONE NumberingStyle.LOWER_LETTERS NumberingStyle.LOWER_ROMAN NumberingStyle.SINGLE_LEADING_ZEROS NumberingStyle.UPPER_LETTERS NumberingStyle.UPPER_ROMAN String	read/write	Numbering format options. Can return: NumberingStyle enumerator or String.
numberingLevel	Number	read/write	The level of the paragraph.
numberingRestartPolicies	NumberingRestartPolicy	readonly	Numbering restart policies.
numberingStartAt	Number	read/write	Determines starting number in a numbered list.
otfContextualAlternate	Boolean	read/write	If true, uses contextual alternate forms in OpenType fonts.
otfDiscretionaryLigature	Boolean	read/write	If true, uses discretionary ligatures in OpenType fonts.
otfFigureStyle	OTFFigureStyle OTFFigureStyle.DEFAULT_VALUE OTFFigureStyle.PROPORTIONAL_LINING OTFFigureStyle.PROPORTIONAL_OLDSTYLE OTFFigureStyle.TABULAR_LINING OTFFigureStyle.TABULAR_OLDSTYLE	read/write	The figure style in OpenType fonts.
otfFraction	Boolean	read/write	If true, uses fractions in OpenType fonts.
otfHistorical	Boolean	read/write	If true, use historical forms in OpenType fonts.
otfLocale	Boolean	read/write	If true, uses localized forms in OpenType fonts.
otfMark	Boolean	read/write	If true, uses mark positioning in OpenType fonts.
otfOrdinal	Boolean	read/write	If true, uses ordinals in OpenType fonts.
otfSlashedZero	Boolean	read/write	If true, use a slashed zeroes in OpenType fonts.
otfStylisticSets	Number	read/write	The stylistic sets to use in OpenType fonts.
otfSwash	Boolean	read/write	If true, uses swash forms in OpenType fonts.
otfTitling	Boolean	read/write	If true, uses titling forms in OpenType fonts.
overprintFill	Boolean	read/write	If true, the fill color of the characters will overprint.
overprintStroke	Boolean	read/write	If true, the stroke of the characters will overprint.
parent	Application Document ParagraphStyleGroup	readonly	The parent of the ParagraphStyle (a Document, Application or ParagraphStyleGroup).
pointSize	Number String	read/write	The text size.
position	Position Position.NORMAL Position.OT_DENOMINATOR Position.OT_NUMERATOR Position.OT_SUBSCRIPT Position.OT_SUPERSCRIPT Position.SUBSCRIPT Position.SUPERSCRIPT	read/write	The text position relative to the baseline.
positionalForm	PositionalForms PositionalForms.CALCULATE PositionalForms.FINAL PositionalForms.INITIAL PositionalForms.ISOLATED PositionalForms.MEDIAL PositionalForms.NONE	read/write	The OpenType positional form.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rightIndent	Number String	read/write	The width of the right indent.
ruleAbove	Boolean	read/write	If true, places a rule above the paragraph.
ruleAboveColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule above. Can return: Swatch or String.
ruleAboveGapColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule above. Note: Valid only when the paragraph rule above type is not solid. Can return: Swatch or String.
ruleAboveGapOverprint	Boolean	read/write	If true, the stroke gap of the paragraph rule above will overprint. Note: Valid only the rule above type is not solid.
ruleAboveGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the stroke gap color of the paragraph rule. (Range: 0 to 100) Note: Valid only when the rule above type is not solid.
ruleAboveLeftIndent	Number String	read/write	The distance to indent the left edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.
ruleAboveLineWeight	Number String	read/write	The line weight of the rule above.
ruleAboveOffset	Number String	read/write	The amount to offset the paragraph rule above from the baseline of the first line the paragraph.
ruleAboveOverprint	Boolean	read/write	If true, the paragraph rule above will overprint.
ruleAboveRightIndent	Number String	read/write	The distance to indent the right edge of the paragraph rule above (based on either the text width or the column width of the first line in the paragraph.
ruleAboveTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100)
ruleAboveType	StrokeStyle String	read/write	The stroke type of the rule above the paragraph. Can return: StrokeStyle or String.
ruleAboveWidth	RuleWidth RuleWidth.COLUMN_WIDTH RuleWidth.TEXT_WIDTH	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule above.
ruleBelow	Boolean	read/write	If true, applies a paragraph rule below.
ruleBelowColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the paragraph rule below. Can return: Swatch or String.
ruleBelowGapColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the paragraph rule below. Note: Valid only when the paragraph rule below type is not solid. Can return: Swatch or String.
ruleBelowGapOverprint	Boolean	read/write	If true, the gap color of the rule below will overprint.
ruleBelowGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the stroke gap color of the paragraph rule below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type is not solid.
ruleBelowLeftIndent	Number String	read/write	The distance to indent the left edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.
ruleBelowLineWeight	Number String	read/write	The line weight of the rule below.
ruleBelowOffset	Number String	read/write	The amount to offset the the paragraph rule below from the baseline of the last line of the paragraph.
ruleBelowOverprint	Boolean	read/write	If true, the rule below will overprint.
ruleBelowRightIndent	Number String	read/write	The distance to indent the right edge of the paragraph rule below (based on either the text width or the column width of the last line in the paragraph.
ruleBelowTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100)
ruleBelowType	StrokeStyle String	read/write	The stroke type of the rule below the paragraph. Can return: StrokeStyle or String.
ruleBelowWidth	RuleWidth RuleWidth.COLUMN_WIDTH RuleWidth.TEXT_WIDTH	read/write	The basis (text width or column width) used to calculate the width of the paragraph rule below.
singleWordJustification	SingleWordJustification SingleWordJustification.CENTER_ALIGN SingleWordJustification.FULLY_JUSTIFIED SingleWordJustification.LEFT_ALIGN SingleWordJustification.RIGHT_ALIGN	read/write	The alignment to use for lines that contain a single word.
skew	Number	read/write	The skew angle of the ParagraphStyle.
spaceAfter	Number String	read/write	The height of the paragraph space below.
spaceBefore	Number String	read/write	The height of the paragraph space above.
startParagraph	StartParagraph StartParagraph.ANYWHERE StartParagraph.NEXT_COLUMN StartParagraph.NEXT_EVEN_PAGE StartParagraph.NEXT_FRAME StartParagraph.NEXT_ODD_PAGE StartParagraph.NEXT_PAGE	read/write	The location at which to start the paragraph.
strikeThroughColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the strikethrough stroke. Can return: Swatch or String.
strikeThroughGapOverprint	Boolean	read/write	If true, the gap color of the strikethrough stroke will overprint. Note: Valid when strike through type is not solid.
strikeThroughGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 to 100) Note: Valid when strike through type is not solid.
strikeThroughOffset	Number String	read/write	The amount by which to offset the strikethrough stroke from the text baseline.
strikeThroughOverprint	Boolean	read/write	If true, the strikethrough stroke will overprint.
strikeThroughTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100)
strikeThroughType	StrokeStyle String	read/write	The stroke type of the strikethrough stroke. Can return: StrokeStyle or String.
strikeThroughWeight	Number String	read/write	The stroke weight of the strikethrough stroke.
strikeThru	Boolean	read/write	If true, draws a strikethrough line through the text.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ParagraphStyle. Can also accept: String.
strokeTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the stroke color of the ParagraphStyle. (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	Number String	read/write	The stroke weight applied to the characters of the text.
tabList	Array of Arrays of Property Name/Value Pairs.	read/write	A list of the tab stops in the paragraph. Can return: Array of Arrays of Property Name/Value Pairs.
tabStops	TabStops TabStop	readonly	A collection of tab stops.
tracking	Number	read/write	The amount by which to loosen or tighten a block of text, specified in thousands of an em.
underline	Boolean	read/write	If true, underlines the text.
underlineColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the underline stroke. . Can return: Swatch or String.
underlineGapColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of the underline stroke. Note: Valid when underline type is not solid. Can return: Swatch or String.
underlineGapOverprint	Boolean	read/write	If true, the gap color of the underline stroke will overprint.
underlineGapTint	Number (range 0 - 100)	read/write	The tint (as a percentage) of the gap color of the underline stroke. (Range: 0 to 100) Note: Valid when underline type is not solid.
underlineOffset	Number String	read/write	The amount by which to offset the underline from the text baseline.
underlineOverprint	Boolean	read/write	If true, the underline stroke color will overprint.
underlineTint	Number (range 0 - 100)	read/write	The underline stroke tint (as a percentage). (Range: 0 to 100)
underlineType	StrokeStyle String	read/write	The stroke type of the underline stroke. Can return: StrokeStyle or String.
underlineWeight	Number String	read/write	The stroke weight of the underline stroke.
verticalScale	Number	read/write	The vertical scaling applied to the ParagraphStyle.

Method Listing

undefined convertBulletsAndNumberingToText ()

Convert bullets and numbering to text.

ParagraphStyle duplicate ()

Duplicates the ParagraphStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

ParagraphStyle getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

ParagraphStyle move (to:LocationOptions, reference:Varies CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application	The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

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: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

undefined remove (replacingWith:ParagraphStyle)

Deletes the style.