Word.Interfaces.NoteItemCollectionLoadOptions interface

Package:

word

Contains a collection of Word.NoteItem objects.

Remarks

[ API set: WordApi 1.5 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
body	For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
reference	For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
type	For EACH ITEM in the collection: Represents the note item type: footnote or endnote.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

body

For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.

body?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.5 ]

reference

For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.

reference?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

Remarks

[ API set: WordApi 1.5 ]

type

For EACH ITEM in the collection: Represents the note item type: footnote or endnote.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]