XMLNode Interface

  • Article

Represents a single XML node on a document that exposes events and that can be bound to data.

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

Syntax

'Declaration
<GuidAttribute("29b82cde-df64-4c6f-a64f-87561e588ecb")> _
Public Interface XMLNode _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize

[GuidAttribute("29b82cde-df64-4c6f-a64f-87561e588ecb")]
public interface XMLNode : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The XMLNode type exposes the following members.

Properties

  Name Description
Public property Application Gets an Application that represents the creator of the XMLNode control.
Public property Attributes Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents the attributes for the XMLNode control.
Public property BaseName Gets the name of the XMLNode control without any prefix.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property ChildNodes Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents the child elements of an XMLNode control.
Public property ChildNodeSuggestions Gets an XMLChildNodeSuggestions collection that represents the elements that may be valid children of the current XMLNode control.
Public property Container Infrastructure.
Public property Creator Gets the application in which the XMLNode control was created.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DefaultDataSourceUpdateMode Gets or sets the default DataSourceUpdateMode for the XMLNode.
Public property FirstChild Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the first child node in the Microsoft.Office.Tools.Word.XMLNode control.
Public property HasChildNodes Gets a value that indicates whether the XMLNode control has child elements.
Public property InnerObject Gets a Microsoft.Office.Interop.Word.XMLNode that represents the underlying native object for the XMLNode.
Public property LastChild Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the last child node of the Microsoft.Office.Tools.Word.XMLNode control.
Public property Level Gets the level of the XMLNode control.
Public property NamespaceURI Gets the Uniform Resource Identifier (URI) of the schema namespace for the XMLNode control.
Public property NextSibling Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the next Microsoft.Office.Interop.Word.XMLNode object in the document that is at the same level as the Microsoft.Office.Tools.Word.XMLNode control.
Public property NodeText Gets or sets the text value of the XMLNode control.
Public property NodeType Gets a value that indicates whether an XMLNode is an attribute or an element.
Public property NodeValue Gets or sets the value of an XMLNode that represents an attribute.
Public property OwnerDocument Gets a Microsoft.Office.Interop.Word.Document that represents the parent document of the specified XMLNode control.
Public property Parent Gets a Microsoft.Office.Interop.Word.Document that represents the document containing the specified XMLNode control.
Public property ParentNode Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the parent element of the specified Microsoft.Office.Tools.Word.XMLNode control.
Public property PlaceholderText Gets or sets the text displayed for an XMLNode control that contains no text.
Public property PreviousSibling Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the previous Microsoft.Office.Interop.Word.XMLNode object in the document that is at the same level as the Microsoft.Office.Tools.Word.XMLNode control.
Public property Range Gets a Range object that represents the portion of a document that is contained in the XMLNode control.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property SmartTag Gets a SmartTag object that represents the smart tag associated with the XMLNode control.
Public property Tag Infrastructure.
Public property Text Gets or sets the plain unformatted text of the XMLNode control.
Public property ValidationErrorText Gets a string that represents the description for a validation error on an XMLNode control.
Public property ValidationStatus Gets a value that specifies whether an element or attribute is valid according to the attached schema.
Public property WordOpenXML Gets an XML string that represents the XMLNode in the Microsoft Office Word Open XML format.
Public property XML Gets a string that represents the XML text in the XMLNode control.

Top

Methods

  Name Description
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Copy Copies the contents of the XMLNode control to the Clipboard.
Public method Cut Removes the contents of the XMLNode control and places the contents onto the Clipboard.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method get_ValidationErrorText Infrastructure.
Public method get_XML Infrastructure.
Public method Load Updates an XMLNode control with data from the specified XML file
Public method LoadXml(String) Populates an XMLNode control with data from the specified XML string.
Public method LoadXml(XmlDocument) Populates an XMLNode control with data from the root node of the specified XmlDocument.
Public method LoadXml(XmlElement) Populates an XMLNode control with data from an XmlElement.
Public method RemoveChild Removes the specified child element from the XMLNode control.
Public method SelectNodes Gets a Microsoft.Office.Interop.Word.XMLNodes collection that represents all the nodes that match the XPath parameter in the order in which they appear in the Microsoft.Office.Tools.Word.XMLNode control.
Public method SelectSingleNode Gets a Microsoft.Office.Interop.Word.XMLNode object that represents the first child node that matches the XPath parameter in the Microsoft.Office.Tools.Word.XMLNode control.
Public method SetValidationError Changes the validation error text displayed to a user for an XMLNode control and forces Microsoft Office Word to report a node as invalid.
Public method Validate Validates an individual XMLNode control against the attached XML schema or schemas.

Top

Events

  Name Description
Public event AfterInsert Occurs when the user adds a new XMLNode control to the document.
Public event BeforeDelete Occurs when the user deletes an XMLNode control from the document, before the control is deleted.
Public event BindingContextChanged Occurs when the value of the BindingContext property of the ContentControlBase changes.
Public event ContextEnter Occurs when the cursor is placed inside an XMLNode or one of its descendent nodes, from an area outside of the context of the node.
Public event ContextLeave Occurs when the cursor is moved from the XMLNode control, or one of its descendent nodes, to an area outside of the context of the original node.
Public event Deselect Occurs when the cursor is moved out of the XMLNode control.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event Select Occurs when the cursor is placed inside an XMLNode control.
Public event ValidationError Occurs when there is a validation error in the XMLNode control.

Top

Remarks

When you map non-repeating schema elements onto a Microsoft Office Word document at design time, Visual Studio creates an XMLNode control for each elements that are allowed to appear only once in a document. A non-repeating schema element is an element with the maxOccurs attribute set to 1.

XMLNode controls can be created only in Word document-level projects at design time. They cannot be created at run time or in application-level projects. For more information, see XMLNode Control and How to: Add XMLNode Controls to Word Documents.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

XMLNode Control

How to: Add XMLNode Controls to Word Documents