VsEnumerable<TComEnumerator,TComEnumerated> Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for VS-style enumerators using Dev10 and older enumerator interfaces that use PreserveSig

generic <typename TComEnumerator, typename TComEnumerated>
public ref class VsEnumerable abstract : Microsoft::VisualStudio::Shell::VsEnumerable<TComEnumerator, TComEnumerated, TComEnumerated>

template <typename TComEnumerator, typename TComEnumerated>
[Windows::Foundation::Metadata::WebHostHidden]
class VsEnumerable abstract : Microsoft::VisualStudio::Shell::VsEnumerable<TComEnumerator, TComEnumerated, TComEnumerated>

public abstract class VsEnumerable<TComEnumerator,TComEnumerated> : Microsoft.VisualStudio.Shell.VsEnumerable<TComEnumerator,TComEnumerated,TComEnumerated>

type VsEnumerable<'ComEnumerator, 'ComEnumerated> = class
    inherit VsEnumerable<'ComEnumerator, 'ComEnumerated, 'ComEnumerated>

Public MustInherit Class VsEnumerable(Of TComEnumerator, TComEnumerated)
Inherits VsEnumerable(Of TComEnumerator, TComEnumerated, TComEnumerated)

Type Parameters

TComEnumerator

COM enumerator type (e.g. IEnumString)

TComEnumerated

Type enumerated by TComEnumerator (e.g. string)

Inheritance: Object

VsEnumerable<TComEnumerator,TComEnumerated,TComEnumerated>
VsEnumerable<TComEnumerator,TComEnumerated>

Derived: Microsoft.VisualStudio.Shell.VsEnumerableEx<TComEnumerator,TComEnumerated>

Constructors

VsEnumerable<TComEnumerator,TComEnumerated>(IEnumerable<TComEnumerated>, Int32)	Initializes a new instance of the VsEnumerable<TComEnumerator,TComEnumerated> class.
VsEnumerable<TComEnumerator,TComEnumerated>(IEnumerable<TComEnumerated>)	Initializes a new instance of the VsEnumerable<TComEnumerator,TComEnumerated> class.

Properties

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>)

Methods

Clone(TComEnumerator)	Creates a copy of the enumerator and all its descendants. The returned enumerator contains the same enumeration state as the current one. (Inherited from VsEnumerable<TComEnumerator,TComEnumerated,TEnumerated>)
CreateEnumerator(IEnumerable<TEnumerated>, Int32)	Create a new instance of derived class that is the COM-enumerator over the enumerated collection, starting from the specified enumerator position. Derived classes need to implement the following pattern: create a private constructor with similar parameters as this function, calling the protected constructor in this base class with the same signature (collection/enumeratorPosition) override the CreateEnumerator function and call the derived class' constructor with the 2 parameters (Inherited from VsEnumerable<TComEnumerator,TComEnumerated,TEnumerated>)
GetElement(TComEnumerated, TComEnumerated)	Converts an element in the enumerated input collection of type `TEnumerated` to a `TComEnumerated` element to be returned by the Visual Studio-style enumerator.
GetElement(TEnumerated, TComEnumerated)	Converts an element in the enumerated input collection of type TEnumerated to a TComEnumerated element to be returned by the VS-style enumerator. (e.g. converts a UIDataSourceVerb to the COM-enumerated type 'string' by selecting the verb's name) (Inherited from VsEnumerable<TComEnumerator,TComEnumerated,TEnumerated>)
Next(UInt32, 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, 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>)
Reset()	Resets the enumeration sequence back to the beginning. (Inherited from VsEnumerable<TComEnumerator,TComEnumerated,TEnumerated>)
Skip(UInt32)	Moves the current position in an enumeration ahead by a specified number of elements. (Inherited from VsEnumerable<TComEnumerator,TComEnumerated,TEnumerated>)

Applies to

Share via