TextParagraph
TextParagraph class
Represents the text paragraph setting.
Properties
| Name | Type | Description |
|---|---|---|
| Bullet | Bullet | Gets the bullet. |
| Type | Number | Gets the type of text node. The value of the property is TextNodeType integer constant. |
| LineSpaceSizeType | Number | Gets and sets the amount of vertical white space that will be used within a paragraph. The value of the property is Line |
| LineSpace | Number | Gets and sets the amount of vertical white space that will be used within a paragraph. |
| SpaceAfterSizeType | Number | Gets and sets the amount of vertical white space that will be present after a paragraph. The value of the property is Li |
| SpaceAfter | Number | Gets and sets the amount of vertical white space that will be present after a paragraph. |
| SpaceBeforeSizeType | Number | Gets and sets the amount of vertical white space that will be present before a paragraph. The value of the property is L |
| SpaceBefore | Number | Gets and sets the amount of vertical white space that will be present before a paragraph. |
| Stops | TextTabStopCollection | 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 | Number | Determines where vertically on a line of text the actual words are positioned. This deals with vertical placement of the |
| AlignmentType | Number | Gets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType intege |
| DefaultTabSize | Number | Gets and sets the default size for a tab character within this paragraph. |
| Children | FontSetting[] | Gets all text runs in this paragraph. If this paragraph is empty, return paragraph itself. |
| StartIndex | Number | Gets the start index of the characters. |
| Length | Number | Gets the length of the characters. |
| Font | Font | Returns the font of this object. |
| TextOptions | TextOptions | Returns the text options. |
Methods
| Name | Description |
|---|---|
| setWordArtStyle | Sets 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: Number
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: Number
TextParagraph.LineSpace property
Gets and sets the amount of vertical white space that will be used within a paragraph.
Type: Number
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: Number
TextParagraph.SpaceAfter property
Gets and sets the amount of vertical white space that will be present after a paragraph.
Type: Number
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: Number
TextParagraph.SpaceBefore property
Gets and sets the amount of vertical white space that will be present before a paragraph.
Type: Number
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: Number
TextParagraph.LeftMargin property
Specifies the left margin of the paragraph.
Type: Number
TextParagraph.FirstLineIndent property
Specifies the indent size that will be applied to the first line of text in the paragraph.
Type: Number
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: Number
TextParagraph.AlignmentType property
Gets and sets the text horizontal alignment type of the paragraph. The value of the property is TextAlignmentType integer constant.
Type: Number
TextParagraph.DefaultTabSize property
Gets and sets the default size for a tab character within this paragraph.
Type: Number
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: Number
TextParagraph.Length property
Gets the length of the characters.
Type: Number
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.
| Parameter | Type | Description |
|---|---|---|
| style | Number | A PresetWordArtStyle value. The preset WordArt style. |