AddInToken.IEnumerable.GetEnumerator Method

Definition

Namespace:

System.AddIn.Hosting

Assembly:

System.AddIn.dll

Returns an enumerator for the qualification data of the pipeline segments that are associated with this token.

 virtual System::Collections::IEnumerator ^ System.Collections.IEnumerable.GetEnumerator() = System::Collections::IEnumerable::GetEnumerator;

System.Collections.IEnumerator IEnumerable.GetEnumerator ();

abstract member System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator
override this.System.Collections.IEnumerable.GetEnumerator : unit -> System.Collections.IEnumerator

Function GetEnumerator () As IEnumerator Implements IEnumerable.GetEnumerator

Returns

IEnumerator

An enumerator that can be used to iterate through the qualification data of the pipeline segments that are associated with the current token.

Implements

GetEnumerator()

Remarks

This method allows a token to be treated like a collection of qualification data items, for example in a foreach statement (For Each in Visual Basic, for each in Visual C++).

Use the enumerator returned by this method to iterate through the qualification data items of the pipeline segments associated with the current token. Each item of qualification data is a QualificationDataItem structure that identifies the pipeline segment and contains the name/value pair from a QualificationDataAttribute attribute applied to that segment.

Note

The add-in model does not use qualification data that is applied to the host view of the add-in. As a result, when you enumerate qualification data you will not find any items whose Segment property is AddInSegmentType.HostViewOfAddIn.

Alternatively, you can use the QualificationData property to get a nested set of dictionaries containing the qualification data of the pipeline segments.