XMLNode Interface

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

Top

Methods

	Name	Description
	BeginInit	Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
	Copy	Copies the contents of the XMLNode control to the Clipboard.
	Cut	Removes the contents of the XMLNode control and places the contents onto the Clipboard.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	EndInit	Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
	get_ValidationErrorText	Infrastructure.
	get_XML	Infrastructure.
	Load	Updates an XMLNode control with data from the specified XML file
	LoadXml(String)	Populates an XMLNode control with data from the specified XML string.
	LoadXml(XmlDocument)	Populates an XMLNode control with data from the root node of the specified XmlDocument.
	LoadXml(XmlElement)	Populates an XMLNode control with data from an XmlElement.
	RemoveChild	Removes the specified child element from the XMLNode control.
	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.
	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.
	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.
	Validate	Validates an individual XMLNode control against the attached XML schema or schemas.

Top

Events

	Name	Description
	AfterInsert	Occurs when the user adds a new XMLNode control to the document.
	BeforeDelete	Occurs when the user deletes an XMLNode control from the document, before the control is deleted.
	BindingContextChanged	Occurs when the value of the BindingContext property of the ContentControlBase changes.
	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.
	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.
	Deselect	Occurs when the cursor is moved out of the XMLNode control.
	Disposed	Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
	Select	Occurs when the cursor is placed inside an XMLNode control.
	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 and the .NET Framework 4.5. 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