TextParagraph

TextParagraph class

Represents the text paragraph setting.

Properties

NameTypeDescription
BulletBulletGets the bullet.
TypeintGets the type of text node. The value of the property is TextNodeType integer constant.
LineSpaceSizeTypeintGets and sets the amount of vertical white space that will be used within a paragraph. The value of the property is Line
LineSpacefloatGets and sets the amount of vertical white space that will be used within a paragraph.
SpaceAfterSizeTypeintGets and sets the amount of vertical white space that will be present after a paragraph. The value of the property is Li
SpaceAfterfloatGets and sets the amount of vertical white space that will be present after a paragraph.
SpaceBeforeSizeTypeintGets and sets the amount of vertical white space that will be present before a paragraph. The value of the property is L
SpaceBeforefloatGets and sets the amount of vertical white space that will be present before a paragraph.
StopsTextTabStopCollectionGets tab stop list.
IsLatinLineBreakbooleanSpecifies whether a Latin word can be broken in half and wrapped onto the next line without a hyphen being added.
IsEastAsianLineBreakbooleanSpecifies whether an East Asian word can be broken in half and wrapped onto the next line without a hyphen being added.
IsHangingPunctuationbooleanSpecifies whether punctuation is to be forcefully laid out on a line of text or put on a different line of text.
RightMarginfloatSpecifies the right margin of the paragraph.
LeftMarginfloatSpecifies the left margin of the paragraph.
FirstLineIndentfloatSpecifies the indent size that will be applied to the first line of text in the paragraph.
FontAlignTypeintDetermines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the
AlignmentTypeintGets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType intege
DefaultTabSizefloatGets and sets the default size for a tab character within this paragraph.
ChildrenFontSetting[]Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself.
StartIndexintGets the start index of the characters.
LengthintGets the length of the characters.
FontFontReturns the font of this object.
TextOptionsTextOptionsReturns the text options.

Methods

NameDescription
setWordArtStyleSets the preset WordArt style.

Only for the text of shape/chart. |

TextParagraph.Bullet property

Gets the bullet.

Type: Bullet

TextParagraph.Type property

Gets the type of text node. The value of the property is TextNodeType integer constant.

Type: int

TextParagraph.LineSpaceSizeType property

Gets and sets the amount of vertical white space that will be used within a paragraph. The value of the property is LineSpaceSizeType integer constant.

Type: int

TextParagraph.LineSpace property

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

Type: float

TextParagraph.SpaceAfterSizeType property

Gets and sets the amount of vertical white space that will be present after a paragraph. The value of the property is LineSpaceSizeType integer constant.

Type: int

TextParagraph.SpaceAfter property

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

Type: float

TextParagraph.SpaceBeforeSizeType property

Gets and sets the amount of vertical white space that will be present before a paragraph. The value of the property is LineSpaceSizeType integer constant.

Type: int

TextParagraph.SpaceBefore property

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

Type: float

TextParagraph.Stops property

Gets tab stop list.

Type: TextTabStopCollection

TextParagraph.IsLatinLineBreak property

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

Type: boolean

TextParagraph.IsEastAsianLineBreak property

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

Type: boolean

TextParagraph.IsHangingPunctuation property

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

Type: boolean

TextParagraph.RightMargin property

Specifies the right margin of the paragraph.

Type: float

TextParagraph.LeftMargin property

Specifies the left margin of the paragraph.

Type: float

TextParagraph.FirstLineIndent property

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

Type: float

TextParagraph.FontAlignType property

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. The value of the property is TextFontAlignType integer constant.

Type: int

TextParagraph.AlignmentType property

Gets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType integer constant.

Type: int

TextParagraph.DefaultTabSize property

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

Type: float

TextParagraph.Children property

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

Type: FontSetting[]

TextParagraph.StartIndex property

Gets the start index of the characters.

Type: int

TextParagraph.Length property

Gets the length of the characters.

Type: int

TextParagraph.Font property

Returns the font of this object.

Type: Font

TextParagraph.TextOptions property

Returns the text options.

Type: TextOptions

setWordArtStyle(style)

Sets the preset WordArt style.

Only for the text of shape/chart.

ParameterTypeDescription
styleintA PresetWordArtStyle value. The preset WordArt style.