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.

Methods

Method	Description
getBullet()	Gets the bullet.
getType()	Gets the type of text node.
getLineSpaceSizeType()	Gets and sets the amount of vertical white space that will be used within a paragraph.
setLineSpaceSizeType(LineSpaceSizeType)	Gets and sets the amount of vertical white space that will be used within a paragraph.
getLineSpace()	Gets and sets the amount of vertical white space that will be used within a paragraph.
setLineSpace(number)	Gets and sets the amount of vertical white space that will be used within a paragraph.
getSpaceAfterSizeType()	Gets and sets the amount of vertical white space that will be present after a paragraph.
setSpaceAfterSizeType(LineSpaceSizeType)	Gets and sets the amount of vertical white space that will be present after a paragraph.
getSpaceAfter()	Gets and sets the amount of vertical white space that will be present after a paragraph.
setSpaceAfter(number)	Gets and sets the amount of vertical white space that will be present after a paragraph.
getSpaceBeforeSizeType()	Gets and sets the amount of vertical white space that will be present before a paragraph.
setSpaceBeforeSizeType(LineSpaceSizeType)	Gets and sets the amount of vertical white space that will be present before a paragraph.
getSpaceBefore()	Gets and sets the amount of vertical white space that will be present before a paragraph.
setSpaceBefore(number)	Gets and sets the amount of vertical white space that will be present before a paragraph.
getStops()	Gets tab stop list.
isLatinLineBreak()	Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
setIsLatinLineBreak(boolean)	Specifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
isEastAsianLineBreak()	Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
setIsEastAsianLineBreak(boolean)	Specifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
isHangingPunctuation()	Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
setIsHangingPunctuation(boolean)	Specifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
getRightMargin()	Specifies the right margin of the paragraph.
setRightMargin(number)	Specifies the right margin of the paragraph.
getLeftMargin()	Specifies the left margin of the paragraph.
setLeftMargin(number)	Specifies the left margin of the paragraph.
getFirstLineIndent()	Specifies the indent size that will be applied to the first line of text in the paragraph.
setFirstLineIndent(number)	Specifies the indent size that will be applied to the first line of text in the paragraph.
getFontAlignType()	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.
setFontAlignType(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.
getAlignmentType()	Gets and sets the text horizontal alignment type of the paragraph.
setAlignmentType(TextAlignmentType)	Gets and sets the text horizontal alignment type of the paragraph.
getDefaultTabSize()	Gets and sets the default size for a tab character within this paragraph.
setDefaultTabSize(number)	Gets and sets the default size for a tab character within this paragraph.
getChildren()	Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.
getStartIndex()	Gets the start index of the characters.
getLength()	Gets the length of the characters.
getFont()	Returns the font of this object.
getTextOptions()	Returns the text options.
setWordArtStyle(PresetWordArtStyle)	Sets the preset WordArt style.

constructor(FontSetting)

Constructs from a parent object convertible to this.

constructor(obj: FontSetting);

Parameters:

Parameter	Type	Description
obj	FontSetting	The parent object.

getBullet()

Gets the bullet.

getBullet() : Bullet;

Returns

Bullet

getType()

Gets the type of text node.

getType() : TextNodeType;

Returns

TextNodeType

getLineSpaceSizeType()

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

getLineSpaceSizeType() : LineSpaceSizeType;

Returns

LineSpaceSizeType

setLineSpaceSizeType(LineSpaceSizeType)

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

setLineSpaceSizeType(value: LineSpaceSizeType) : void;

Parameters:

Parameter	Type	Description
value	LineSpaceSizeType	The value to set.

getLineSpace()

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

getLineSpace() : number;

setLineSpace(number)

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

setLineSpace(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSpaceAfterSizeType()

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

getSpaceAfterSizeType() : LineSpaceSizeType;

Returns

LineSpaceSizeType

setSpaceAfterSizeType(LineSpaceSizeType)

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

setSpaceAfterSizeType(value: LineSpaceSizeType) : void;

Parameters:

Parameter	Type	Description
value	LineSpaceSizeType	The value to set.

getSpaceAfter()

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

getSpaceAfter() : number;

setSpaceAfter(number)

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

setSpaceAfter(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSpaceBeforeSizeType()

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

getSpaceBeforeSizeType() : LineSpaceSizeType;

Returns

LineSpaceSizeType

setSpaceBeforeSizeType(LineSpaceSizeType)

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

setSpaceBeforeSizeType(value: LineSpaceSizeType) : void;

Parameters:

Parameter	Type	Description
value	LineSpaceSizeType	The value to set.

getSpaceBefore()

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

getSpaceBefore() : number;

setSpaceBefore(number)

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

setSpaceBefore(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getStops()

Gets tab stop list.

getStops() : TextTabStopCollection;

Returns

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;

setIsLatinLineBreak(boolean)

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

setIsLatinLineBreak(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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;

setIsEastAsianLineBreak(boolean)

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

setIsEastAsianLineBreak(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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;

setIsHangingPunctuation(boolean)

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

setIsHangingPunctuation(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRightMargin()

Specifies the right margin of the paragraph.

getRightMargin() : number;

setRightMargin(number)

Specifies the right margin of the paragraph.

setRightMargin(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeftMargin()

Specifies the left margin of the paragraph.

getLeftMargin() : number;

setLeftMargin(number)

Specifies the left margin of the paragraph.

setLeftMargin(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getFirstLineIndent()

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

getFirstLineIndent() : number;

setFirstLineIndent(number)

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

setFirstLineIndent(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getFontAlignType()

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.

getFontAlignType() : TextFontAlignType;

Returns

TextFontAlignType

setFontAlignType(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.

setFontAlignType(value: TextFontAlignType) : void;

Parameters:

Parameter	Type	Description
value	TextFontAlignType	The value to set.

getAlignmentType()

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

getAlignmentType() : TextAlignmentType;

Returns

TextAlignmentType

setAlignmentType(TextAlignmentType)

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

setAlignmentType(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getDefaultTabSize()

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

getDefaultTabSize() : number;

setDefaultTabSize(number)

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

setDefaultTabSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getChildren()

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

getChildren() : FontSetting[];

Returns

FontSetting[]

getStartIndex()

Gets the start index of the characters.

getStartIndex() : number;

getLength()

Gets the length of the characters.

getLength() : number;

getFont()

Returns the font of this object.

getFont() : Font;

Returns

Font

getTextOptions()

Returns the text options.

getTextOptions() : TextOptions;

Returns

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.