Edit

Share via


Word.Interfaces.BookmarkLoadOptions interface

Represents a single bookmark in a document, selection, or range. The Bookmark object is a member of the Bookmark collection. The Word.BookmarkCollection includes all the bookmarks listed in the Bookmark dialog box (Insert menu).

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

Specifies the ending character position of the bookmark.

isColumn

Returns true if the bookmark is a table column.

isEmpty

Returns true if the bookmark is empty.

name

Returns the name of the Bookmark object.

range

Returns a Range object that represents the portion of the document that's contained in the Bookmark object.

start

Specifies the starting character position of the bookmark.

storyType

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

Specifies the ending character position of the bookmark.

end?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isColumn

Returns true if the bookmark is a table column.

isColumn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isEmpty

Returns true if the bookmark is empty.

isEmpty?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

name

Returns the name of the Bookmark object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

range

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

Specifies the starting character position of the bookmark.

start?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

storyType

Returns the story type for the bookmark.

storyType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]