VsEnumerableEx<TComEnumerator, TComEnumerated> Class
Base class for Visual Studio COM enumerators using Visual Studio 2012 and later enumerator interfaces that do not use PreserveSig.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Shell.VsEnumerable<TComEnumerator, TComEnumerated, TComEnumerated>
Microsoft.VisualStudio.Shell.VsEnumerable<TComEnumerator, TComEnumerated>
Microsoft.VisualStudio.Shell.VsEnumerableEx<TComEnumerator, TComEnumerated>
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)
Syntax
'Declaration
Public MustInherit Class VsEnumerableEx(Of TComEnumerator, TComEnumerated) _
Inherits VsEnumerable(Of TComEnumerator, TComEnumerated)
public abstract class VsEnumerableEx<TComEnumerator, TComEnumerated> : VsEnumerable<TComEnumerator, TComEnumerated>
generic<typename TComEnumerator, typename TComEnumerated>
public ref class VsEnumerableEx abstract : public VsEnumerable<TComEnumerator, TComEnumerated>
[<AbstractClass>]
type VsEnumerableEx<'TComEnumerator, 'TComEnumerated> =
class
inherit VsEnumerable<'TComEnumerator, 'TComEnumerated>
end
JScript does not support generic types or methods.
Type Parameters
- TComEnumerator
COM enumerator type (for example, IVsEnumWindowSearchOptions).
- TComEnumerated
Type enumerated by TComEnumerator (for example, IVsWindowSearchOption).
The VsEnumerableEx<TComEnumerator, TComEnumerated> type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
VsEnumerableEx<TComEnumerator, TComEnumerated>(IEnumerable<TComEnumerated>) | Initializes a new instance of the VsEnumerableEx<TComEnumerator, TComEnumerated> class. |
.gif "Protected method") |
VsEnumerableEx<TComEnumerator, TComEnumerated>(IEnumerable<TComEnumerated>, Int32) | Initializes a new instance of the VsEnumerableEx<TComEnumerator, TComEnumerated> class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
IsEnumerating | Gets a Boolean value that indicates whether the enumerator is currently enumerating. If true, the enumerator is enumerating. (Inherited from VsEnumerable<TComEnumerator, TComEnumerated, TEnumerated>.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Clone | Creates a copy of the enumerator and all its descendants. The returned enumerator contains the same enumeration state as the current one. |
|
CreateEnumerator | Creates a new instance of derived class that is the COM-enumerator over the enumerated collection, starting from the specified enumerator position. (Inherited from VsEnumerable<TComEnumerator, TComEnumerated, TEnumerated>.) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetElement | Converts an element in the enumerated input collection of type TEnumerated to a TComEnumerated element to be returned by the Visual Studio-style enumerator. (Inherited from VsEnumerable<TComEnumerator, TComEnumerated>.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
Next(UInt32, array<TComEnumerated[], UInt32%) | Gets one or more elements starting at the current position in an enumeration. This method advances the current position in the enumeration by celt elements, so that subsequent calls return the subsequent elements. (Inherited from VsEnumerable<TComEnumerator, TComEnumerated, TEnumerated>.) |
|
Next(UInt32, array<TComEnumerated[], array<UInt32[]) | (Inherited from VsEnumerable<TComEnumerator, TComEnumerated, TEnumerated>.) |
|
Reset | Resets the enumeration sequence back to the beginning. |
|
Skip | Moves the current position in an enumeration ahead by a specified number of elements. (Inherited from VsEnumerable<TComEnumerator, TComEnumerated, TEnumerated>.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.