Edit

Share via

Word.Interfaces.BookmarkData interface

Package:
word

An interface describing the data returned by calling bookmark.toJSON().

Properties

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

end

Specifies the ending character position of the bookmark.

end?: number;

Property Value

number

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?: string;

Property Value

string

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.RangeData;

Property Value

Word.Interfaces.RangeData

Remarks

[ API set: WordApiDesktop 1.4 ]

start

Specifies the starting character position of the bookmark.

start?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.4 ]

storyType

Returns the story type for the bookmark.

storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice";

Property Value

Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"

Remarks

[ API set: WordApiDesktop 1.4 ]