Bookmark.Text Property

Definition

Namespace:

Microsoft.Office.Tools.Word

Assembly:

Microsoft.Office.Tools.Word.dll

Gets or sets the text in the Bookmark control.

public:
 property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };

public string Text { get; set; }

member this.Text : string with get, set

Public Property Text As String

Property Value

String

The text of the Bookmark control.

Examples

The following code example adds a Bookmark control with text and then displays the total number of characters in the bookmark using the ComputeStatistics method.

This example is for a document-level customization.

private void BookmarkComputeStatistics()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "This is sample bookmark text.";
    int totalCharacters = bookmark1.ComputeStatistics(Word
        .WdStatistic.wdStatisticCharacters);
    MessageBox.Show("The bookmark contains " + 
        totalCharacters.ToString() + " characters.");
}

Private Sub BookmarkComputeStatistics()

    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")
    Bookmark1.Text = "This is sample bookmark text."

    Dim totalCharacters As Integer = Bookmark1.ComputeStatistics( _
        Word.WdStatistic.wdStatisticCharacters)
    MessageBox.Show("The bookmark contains " & _
        totalCharacters.ToString() & " characters.")

End Sub

Remarks

The Text property returns the plain, unformatted text of the bookmark. When you set this property, the text of the Bookmark control is replaced.

Setting the Microsoft.Office.Tools.Word.Bookmark.Text property does not delete the bookmark.

Setting the Microsoft.Office.Tools.Word.Bookmark.Text property of a bookmark that spans multiple table cells will set the text within the first cell only. If the bookmark contains the entire table and surrounding text, the entire table will be deleted.

For information about setting the Microsoft.Office.Tools.Word.Bookmark.Text property of a bookmark that overlaps another bookmark, see Bookmark Control.