Class

WordBookmark

OfficeIMO.Word

Edit on GitHub

Namespace: OfficeIMO.Word
Assembly: OfficeIMO.Word
Source revision: 0eef6a5756b9 with working tree changes
Source: WordBookmark.cs:70
Base: WordElement

Represents a bookmark within a Word document.

Inheritance

WordElement
WordBookmark

Usage

Explore 13 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 13

Methods

public static WordBookmark AddBookmark(WordParagraph paragraph, string bookmarkName) #

WordBookmark.cs:136

Adds a bookmark to the specified paragraph.

Parameters

paragraph OfficeIMO.Word.WordParagraph required: Paragraph to contain the bookmark.
bookmarkName string required: Name of the bookmark.

Returns

WordBookmark The created bookmark.

public WordRange GetRange() #

WordBookmark.cs:70

Returns the range between the bookmark's start and end.

Returns

WordRange The bookmarked range; empty when the bookmark marks a position rather than text.

public void Remove() #

WordBookmark.cs:125

Removes the bookmark from the document.

Inherited Methods

Properties

public WordParagraph Paragraph { get; } #

WordBookmark.cs:13

Gets the paragraph containing the bookmark.

public string? Name { get; set; } #

WordBookmark.cs:44

Gets or sets the bookmark name.

public int Id { get; set; } #

WordBookmark.cs:52

Gets or sets the bookmark identifier.

public string Text { get; set; } #

WordBookmark.cs:63

Gets or sets the text the bookmark spans. Paragraph breaks are returned as \n. Setting the text replaces the bookmarked content and keeps the bookmark around the new text, so REF and cross-reference fields show it after their next update.