ForEachNodeListEnumerator Class

Definition

Defines a class used to enumerate a set of XML nodes that result from applying an XPath expression to an XML file.

public ref class ForEachNodeListEnumerator sealed : Microsoft::SqlServer::Dts::Runtime::ForEachEnumerator, Microsoft::SqlServer::Dts::Runtime::Enumerators::NodeList::IDTSForEachNodeListEnumerator, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class ForEachNodeListEnumerator : Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator, Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.IDTSForEachNodeListEnumerator, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class ForEachNodeListEnumerator : Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator, Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.IDTSForEachNodeListEnumerator, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class ForEachNodeListEnumerator : Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator, Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.IDTSForEachNodeListEnumerator, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type ForEachNodeListEnumerator = class
    inherit ForEachEnumerator
    interface IDTSForEachNodeListEnumerator
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type ForEachNodeListEnumerator = class
    inherit ForEachEnumerator
    interface IDTSForEachNodeListEnumerator
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.Localized), UITypeName="Microsoft.SqlServer.NodeListEnumeratorUI.NodeListControl, Microsoft.SqlServer.NodeListEnumeratorUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type ForEachNodeListEnumerator = class
    inherit ForEachEnumerator
    interface IDTSForEachNodeListEnumerator
    interface IDTSComponentPersist
Public NotInheritable Class ForEachNodeListEnumerator
Inherits ForEachEnumerator
Implements IDTSComponentPersist, IDTSForEachNodeListEnumerator
Inheritance
ForEachNodeListEnumerator
Attributes
Implements

Constructors

ForEachNodeListEnumerator()

Initializes a new instance of the ForEachNodeListEnumerator class.

Properties

CollectionEnumerator

Returns a Boolean indicating whether the enumerator type is an element collection.

EnumerationType

Gets or sets this property to a value from the EnumerationType enumeration.

InnerElementType

Gets or sets this property to a value from the InnerElementType enumeration.

InnerXPathString

Specifies the XPath string, or the name of the variable containing the XPath string, depending on the value of InnerXPathStringSourceType.

InnerXPathStringSourceType

Gets or sets the source type of the inner XPath string using values from the SourceType enumeration.

NodeList

Gets an ArrayList class that contains a collection of nodes that the XPath operation produces.

OuterXPathString

Get or sets a value that represents either the XPath string, the name of the file containing the XPath string, or the name of the variable containing the XPath string, depending on the value of OuterXPathStringSourceType.

OuterXPathStringSourceType

Gets or sets the source type of the XPath string, using values in the SourceType enumeration.

SourceDocument

Gets or sets a value that represents either the XML source document as a string, the name of the file containing the XML source document, or the name of the variable containing the XML source document, depending on the value of SourceDocumentType.

SourceDocumentType

Gets or sets the type of source that the source document is, using the SourceType enumerator.

TargetServerVersion (Inherited from ForEachEnumerator)
Version

Returns the version number of the package. This property is read-only.

(Inherited from ForEachEnumerator)

Methods

CanUpdate(String)

A Boolean that indicates if the new package XML can update the old package XML.

(Inherited from ForEachEnumerator)
Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Returns an IEnumerator interface that can iterate over the ActiveX Data Objects (ADO) object.

GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
InitializeForEachEnumerator(Connections, IDTSInfoEvents, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

(Inherited from ForEachEnumerator)
LoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the LoadPackage(String, IDTSEvents) method.

SaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

Update(String)

This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from ForEachEnumerator)
Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

(Inherited from ForEachEnumerator)

Applies to