Edit

Share via

Word.Interfaces.SectionLoadOptions interface

Package:
word

Represents a section in a Word document.

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).
body

Gets the body object of the section. This doesn't include the header/footer and other section metadata.
pageSetup

Returns a PageSetup object that's associated with the section.
protectedForForms

Specifies if the section is protected for forms.

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

body

Gets the body object of the section. This doesn't include the header/footer and other section metadata.

body?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.1 ]

pageSetup

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns a PageSetup object that's associated with the section.

pageSetup?: Word.Interfaces.PageSetupLoadOptions;

Property Value

Word.Interfaces.PageSetupLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

protectedForForms

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies if the section is protected for forms.

protectedForForms?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]