Edit

Share via


Word.Interfaces.BookmarkCollectionLoadOptions interface

A collection of Word.Bookmark objects that represent the bookmarks in the specified selection, range, or document.

Remarks

[ API set: WordApiDesktop 1.4 ]

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

end

For EACH ITEM in the collection: Specifies the ending character position of the bookmark.

isColumn

For EACH ITEM in the collection: Returns true if the bookmark is a table column.

isEmpty

For EACH ITEM in the collection: Returns true if the bookmark is empty.

name

For EACH ITEM in the collection: Returns the name of the Bookmark object.

range

For EACH ITEM in the collection: Returns a Range object that represents the portion of the document that's contained in the Bookmark object.

start

For EACH ITEM in the collection: Specifies the starting character position of the bookmark.

storyType

For EACH ITEM in the collection: Returns the story type for the bookmark.

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

end

For EACH ITEM in the collection: Specifies the ending character position of the bookmark.

end?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isColumn

For EACH ITEM in the collection: Returns true if the bookmark is a table column.

isColumn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isEmpty

For EACH ITEM in the collection: Returns true if the bookmark is empty.

isEmpty?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

name

For EACH ITEM in the collection: Returns the name of the Bookmark object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

range

For EACH ITEM in the collection: Returns a Range object that represents the portion of the document that's contained in the Bookmark object.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

start

For EACH ITEM in the collection: Specifies the starting character position of the bookmark.

start?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

storyType

For EACH ITEM in the collection: Returns the story type for the bookmark.

storyType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]