Bookmark.TextRetrievalMode Property
Gets or sets a TextRetrievalMode object that controls how text is retrieved from the Bookmark control.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
Syntax
'Declaration
Property TextRetrievalMode As TextRetrievalMode
TextRetrievalMode TextRetrievalMode { get; set; }
Property Value
Type: TextRetrievalMode
A TextRetrievalMode object that controls how text is retrieved from the Bookmark control.
Examples
The following code example adds a Bookmark control with text to the document, hides the third word in the bookmark, and sets the TextRetrievalMode so that hidden text is not included. It then displays the text of the bookmark in a message box.
This example is for a document-level customization.
Private Sub BookmarkTextRetrievalMode()
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).Font.Hidden = True
Bookmark1.TextRetrievalMode.IncludeHiddenText = False
MessageBox.Show("The text in Bookmark1 is: " & Bookmark1.Text)
End Sub
private void BookmarkTextRetrievalMode()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
int WordTrue = 1;
Microsoft.Office.Tools.Word.Bookmark bookmark1 =
this.Controls.AddBookmark(this.Paragraphs[1].Range,
"bookmark1");
bookmark1.Text = "This is sample bookmark text.";
bookmark1.Words[3].Font.Hidden = WordTrue;
bookmark1.TextRetrievalMode.IncludeHiddenText = false;
MessageBox.Show("The text in bookmark1 is: " + bookmark1.Text);
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.