XMLNodes Interface

Definition

A collection of XMLNode objects that represent the nodes in the tree view of the XML Structure task pane, which indicates the elements that a user has applied to a document.

[System.Runtime.InteropServices.Guid("23ba8297-db6f-48b4-8730-8056ebde2d56")]
public interface XMLNodes : IDisposable, System.ComponentModel.ISupportInitialize
Attributes
Implements

Remarks

The XMLNodes control represents a collection of XML elements with the same name. When you map elements that the schema allows to appear more than once onto a Microsoft Office Word document at design time, Visual Studio creates XMLNodes for the elements. A schema can allow an element to appear more than once when the maxOccurs attribute of the element or the element's ancestors is set to > 1.

If the schema sets the maxOccurs attribute for the element and its ancestors to 1, Visual Studio creates an XMLNode control instead.

XMLNodes 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 XMLNodes Control and How to: Add XMLNodes 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 or later. 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: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

Application

Gets a Application object that represents the Microsoft Office Word application.

Container
Count

Gets the number of items in the XMLNodes collection.

Creator

Gets the application in which the XMLNodes control was created.

InnerObject

Gets a XMLNodes that represents the underlying native object for the XMLNodes control.

Item[Int32]

Gets the XMLNode at the specified index.

Parent

Gets a Document that represents the document containing the XMLNodes collection.

Tag

Methods

Add(String, String, Object)

Gets a XMLNode object that represents a newly added element.

GetEnumerator()

Gets the enumerator for the XMLNodes control.

Events

AfterInsert

Occurs when the user adds a new XMLNode to the collection or to one of its descendents.

BeforeDelete

Occurs when the user deletes a XMLNode or descendent node from the collection, before the control is deleted.

ContextEnter

Occurs when the cursor is placed inside one of the nodes or descendant nodes of the XMLNodes collection, from an area outside of the context of the node.

ContextLeave

Occurs when the cursor is moved from one of the nodes or descendant nodes of the XMLNodes collection, to an area outside of the context of the original node.

Deselect

Occurs when the cursor is moved out of one of the nodes of the XMLNodes collection.

Select

Occurs when the cursor is placed inside one of the nodes of the XMLNodes collection.

ValidationError

Occurs when there is a validation error in the XMLNodes control.

Applies to