Bookmark.InsertXML(String, Object) Method

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.

Inserts the specified XML text into the Bookmark control.

public void InsertXML (string XML, ref object Transform);

abstract member InsertXML : string * obj -> unit

Public Sub InsertXML (XML As String, Optional ByRef Transform As Object)

Parameters

XML: String

The XML text to insert.

Transform: Object

The transform to apply to the inserted XML text.

Examples

The following code example adds a Bookmark control to the document and then inserts XML text into the bookmark. A message box is then displayed to show 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

If the Bookmark control contains text, the InsertXML method replaces the existing text.

Calling this method might delete the Bookmark control.

Use the InsertXML method to insert text marked up with either arbitrary XML or Word XML. The XML must be well formed. If it uses Word XML, then it must also be valid according to the Word XML schema.

If the specified XML text cannot be inserted into the Bookmark control, an error message is displayed.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

共用方式為