PredeclaredId

@PredeclaredId annotation, indicates the presence of VB_Predeclared module attribute value (True) that defines a default instance for the class, named after that class. Use the quick-fixes to "Rubberduck Opportunities" code inspections to synchronize annotations and attributes.

New This feature is currently only available in pre-release builds (or the xmldoc asset doesn’t yet exist on main!).

Remarks

Consider keeping the default/predeclared instance stateless.

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)

'@PredeclaredId
Option Explicit
Public Function Create() As Class1
    Set Create = New Class1
End Sub

Class1 (synchronized, hidden attributes shown)

Attribute VB_PredeclaredId = True
'@PredeclaredId
Option Explicit
Public Function Create() As Class1
    Set Create = New Class1
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