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

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 the ending character position of the bookmark.

end?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isColumn

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 true if the bookmark is a table column.

isColumn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isEmpty

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 true if the bookmark is empty.

isEmpty?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

name

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 the name of the Bookmark object.

name?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

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 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: WordApi BETA (PREVIEW ONLY) ]

start

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 the starting character position of the bookmark.

start?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

storyType

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 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: WordApi BETA (PREVIEW ONLY) ]