Bookmark.XML 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 the XML text in the Bookmark control.

public:
 property Microsoft::Office::Tools::Word::Bookmark_XMLType ^ XML { Microsoft::Office::Tools::Word::Bookmark_XMLType ^ get(); };

public Microsoft.Office.Tools.Word.Bookmark_XMLType XML { get; }

member this.XML : Microsoft.Office.Tools.Word.Bookmark_XMLType

Public ReadOnly Property XML As Bookmark_XMLType

Property Value

Bookmark_XMLType

The XML text in the Bookmark control.

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

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

Remarks

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

Parameter	Description
`DataOnly`	`true` to return the text of the XML without the Word XML markup; otherwise, `false`.

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.

Applies to

Product	Versions
Visual Studio Tools for Office	2017, 2019, 2022

Share via