Bookmark.HighlightColorIndex Property

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the highlight color for the Bookmark control.

public:
 property Microsoft::Office::Interop::Word::WdColorIndex HighlightColorIndex { Microsoft::Office::Interop::Word::WdColorIndex get(); void set(Microsoft::Office::Interop::Word::WdColorIndex value); };

public Microsoft.Office.Interop.Word.WdColorIndex HighlightColorIndex { get; set; }

member this.HighlightColorIndex : Microsoft.Office.Interop.Word.WdColorIndex with get, set

Public Property HighlightColorIndex As WdColorIndex

Property Value

WdColorIndex

One of the WdColorIndex values.

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 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;
}

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

Remarks

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

Applies to