Share via


Bookmark.HighlightColorIndex Property

Gets or sets the highlight color for the Bookmark control.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Property HighlightColorIndex As WdColorIndex
WdColorIndex HighlightColorIndex { get; set; }

Property Value

Type: Microsoft.Office.Interop.Word.WdColorIndex
One of the WdColorIndex values.

Remarks

Setting this property to wdNoHighlight removes the highlight color (if any) from the Bookmark control.

Examples

The following code example adds a Bookmark control with text to the first paragraph and then sets the HighlightColorIndex of the third word in the bookmark to yellow.

This example is for a document-level customization.

Private Sub BookmarkHighlightColorIndex()
    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."
    Bookmark1.Words(3).HighlightColorIndex = _
        Word.WdColorIndex.wdYellow

End Sub
private void BookmarkHighlightColorIndex()
{
    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.";
    bookmark1.Words[3].HighlightColorIndex = Word.WdColorIndex.wdYellow;
}

.NET Framework Security

See Also

Reference

Bookmark Interface

Microsoft.Office.Tools.Word Namespace