Bookmark.XML Property

Gets the XML text in the Bookmark control.

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

Syntax

'Declaration
ReadOnly Property XML As Bookmark_XMLType

Bookmark_XMLType XML { get; }

Property Value

Type: Microsoft.Office.Tools.Word.Bookmark_XMLType
The XML text in the Bookmark control.

Remarks

The XML property is intended to be used with the following parameter.

If you use the XML property without specifying a parameter, it returns a Bookmark_XMLType object that is not intended to be used directly from your code.

Examples

The following code example adds a Bookmark control to the document and then inserts XML text into the bookmark. A message box then displays the total number of XMLNodes and the XML content of the bookmark.

This example is for a document-level customization.

Private Sub BookmarkInsertXML()

    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")
    Bookmark1.Text = "Sample of bookmark text."
    Bookmark1.Words(1).InsertXML( _
        "<example>This is an example.</example>")
    MessageBox.Show("Total XMLNodes in Bookmark1: " & _
        Bookmark1.XMLNodes.Count.ToString & vbLf & vbLf & _
        "XML contents: " & Bookmark1.XML(True))

End Sub

private void BookmarkInsertXML()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "Sample of bookmark text.";

    bookmark1.Words[1].InsertXML("<example>This is an example.</example>",
        ref missing);

    MessageBox.Show("Total XMLNodes in bookmark1: " + bookmark1.XMLNodes.Count +
        "\n" + "XML contents: " + bookmark1.XML[true]);
}

.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.

See Also

Reference

Bookmark Interface

Microsoft.Office.Tools.Word Namespace