Edit

Share via

Word.Interfaces.BodyLoadOptions interface

  • Reference
Package:
word

Represents the body of a document or a section.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
font

Gets the text format of the body. Use this to get and set font name, size, color and other properties.
parentContentControl

Gets the content control that contains the body. Throws an ItemNotFound error if there isn't a parent content control.
style

Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
text

Gets the text of the body. Use the insertText method to insert text.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

font

Gets the text format of the body. Use this to get and set font name, size, color and other properties.

font?: Word.Interfaces.FontLoadOptions;

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi 1.1 ]

parentContentControl

Gets the content control that contains the body. Throws an ItemNotFound error if there isn't a parent content control.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.1 ]

style

Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.

style?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

text

Gets the text of the body. Use the insertText method to insert text.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]