TextParagraph

TextParagraph class

Represents the text paragraph setting.

class TextParagraph extends FontSetting;

Constructors

Name	Description
constructor(FontSetting)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
bullet	Bullet	Readonly. Gets the bullet.
lineSpaceSizeType	LineSpaceSizeType	Gets and sets the amount of vertical white space that will be used within a paragraph.
lineSpace	number	Gets and sets the amount of vertical white space that will be used within a paragraph.
spaceAfterSizeType	LineSpaceSizeType	Gets and sets the amount of vertical white space that will be present after a paragraph.
spaceAfter	number	Gets and sets the amount of vertical white space that will be present after a paragraph.
spaceBeforeSizeType	LineSpaceSizeType	Gets and sets the amount of vertical white space that will be present before a paragraph.
spaceBefore	number	Gets and sets the amount of vertical white space that will be present before a paragraph.
stops	TextTabStopCollection	Readonly. Gets tab stop list.
isLatinLineBreak	boolean	Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
isEastAsianLineBreak	boolean	Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
isHangingPunctuation	boolean	Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
rightMargin	number	Specifies the right margin of the paragraph.
leftMargin	number	Specifies the left margin of the paragraph.
firstLineIndent	number	Specifies the indent size that will be applied to the first line of text in the paragraph.
fontAlignType	TextFontAlignType	Determines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the characters with respect to the baselines.
alignmentType	TextAlignmentType	Gets and sets the text horizontal alignment type of the paragraph.
defaultTabSize	number	Gets and sets the default size for a tab character within this paragraph.
children	FontSetting[]	Readonly. Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.
startIndex	number	Readonly. Gets the start index of the characters.
length	number	Readonly. Gets the length of the characters.
font	Font	Readonly. Returns the font of this object.
textOptions	TextOptions	Readonly. Returns the text options.

Methods

Method	Description
setWordArtStyle(PresetWordArtStyle)	Sets the preset WordArt style.
getType()	Gets the type of text node.

constructor(FontSetting)

Constructs from a parent object convertible to this.

constructor(obj: FontSetting);

Parameters:

Parameter	Type	Description
obj	FontSetting	The parent object.

bullet

Readonly. Gets the bullet.

bullet : Bullet;

lineSpaceSizeType

Gets and sets the amount of vertical white space that will be used within a paragraph.

lineSpaceSizeType : LineSpaceSizeType;

lineSpace

Gets and sets the amount of vertical white space that will be used within a paragraph.

lineSpace : number;

spaceAfterSizeType

Gets and sets the amount of vertical white space that will be present after a paragraph.

spaceAfterSizeType : LineSpaceSizeType;

spaceAfter

Gets and sets the amount of vertical white space that will be present after a paragraph.

spaceAfter : number;

spaceBeforeSizeType

Gets and sets the amount of vertical white space that will be present before a paragraph.

spaceBeforeSizeType : LineSpaceSizeType;

spaceBefore

Gets and sets the amount of vertical white space that will be present before a paragraph.

spaceBefore : number;

stops

Readonly. Gets tab stop list.

stops : TextTabStopCollection;

isLatinLineBreak

Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.

isLatinLineBreak : boolean;

isEastAsianLineBreak

Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.

isEastAsianLineBreak : boolean;

isHangingPunctuation

Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.

isHangingPunctuation : boolean;

rightMargin

Specifies the right margin of the paragraph.

rightMargin : number;

leftMargin

Specifies the left margin of the paragraph.

leftMargin : number;

firstLineIndent

Specifies the indent size that will be applied to the first line of text in the paragraph.

firstLineIndent : number;

fontAlignType

Determines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the characters with respect to the baselines.

fontAlignType : TextFontAlignType;

alignmentType

Gets and sets the text horizontal alignment type of the paragraph.

alignmentType : TextAlignmentType;

defaultTabSize

Gets and sets the default size for a tab character within this paragraph.

defaultTabSize : number;

children

Readonly. Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.

children : FontSetting[];

startIndex

Readonly. Gets the start index of the characters.

startIndex : number;

length

Readonly. Gets the length of the characters.

length : number;

font

Readonly. Returns the font of this object.

font : Font;

textOptions

Readonly. Returns the text options.

textOptions : TextOptions;

setWordArtStyle(PresetWordArtStyle)

Sets the preset WordArt style.

setWordArtStyle(style: PresetWordArtStyle) : void;

Parameters:

Parameter	Type	Description
style	PresetWordArtStyle	The preset WordArt style.

Remarks

Only for the text of shape/chart.

getType()

Gets the type of text node.

getType() : TextNodeType;

Returns

TextNodeType