Word.Interfaces.BookmarkData interface
An interface describing the data returned by calling bookmark.toJSON().
Properties
| end | Specifies the ending character position of the bookmark. |
| is |
Returns |
| is |
Returns |
| name | Returns the name of the |
| range | Returns a |
| start | Specifies the starting character position of the bookmark. |
| story |
Returns the story type for the bookmark. |
Property Details
end
Specifies the ending character position of the bookmark.
end?: number;Property Value
number
Remarks
isColumn
Returns true if the bookmark is a table column.
isColumn?: boolean;Property Value
boolean
Remarks
isEmpty
Returns true if the bookmark is empty.
isEmpty?: boolean;Property Value
boolean
Remarks
name
Returns the name of the Bookmark object.
name?: string;Property Value
string
Remarks
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
Remarks
start
Specifies the starting character position of the bookmark.
start?: number;Property Value
number
Remarks
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"