EnumeratorMember

@Enumerator annotation, indicates that the member should have a VB_UserMemId attribute value (-4) making it the enumerator-provider member of that class, enabling 'For Each' iteration of custom collections. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.


Examples

Each example is a self-contained MCVE showing the feature in a single specific scenario.

Standard Module
Named Module1 by default, these are general-purpose standard procedural modules.
Class Module
Named Class1 by default, these modules define the default interface for an object of that type.
Predeclared Class
A class module with its VB_PredeclaredId attribute set to True (with or without a @PredeclaredId annotation).
Interface Module
Abstract interfaces are class modules (with or without an @Interface annotation) whose default interface is not a class type intended to be instantiated.
UserForm Module
A predeclared class with a design-time visual designer using the MSForms UI framework.
Document Module
Owned by the host application, these class modules belong to the host document and may handle various events fired by the host application.

Class1 (code pane)

Option Explicit
Private InternalState As VBA.Collection
'@Enumerator
Public Property Get NewEnum() As IUnknown
    Set NewEnum = InternalState.[_NewEnum]
End Sub
Private Sub Class_Initialize()
    Set InternalState = New VBA.Collection
End Sub

Class1 (synchronized, hidden attributes shown)

Option Explicit
Private InternalState As VBA.Collection
'@Enumerator
Public Property Get NewEnum() As IUnknown
    Attribute NewEnum.VB_UserMemId = -4
    Set NewEnum = InternalState.[_NewEnum]
End Sub
Private Sub Class_Initialize()
    Set InternalState = New VBA.Collection
End Sub

Back to list

The content of this page was generated from xml/comments in the source code compiled into Rubberduck.Parsing.xml. Edit this page