Table of Contents

Class DescribedSymbol

Namespace
RDCore.SDK.Platform.Protocol
Assembly
RDCore.SDK.dll

What is known of a symbol, wherever its declaration is written: the facts SymbolDescription and the assistant tools' description share.

public abstract record DescribedSymbol : IEquatable<DescribedSymbol>
Inheritance
DescribedSymbol
Implements
Derived
Inherited Members

Remarks

The facts of a declaration's use (IsImplicit, Role, References, Hides, AutoInstantiates) are known where the environment host has the module: a null says they are not known, never that there are none.

Properties

Access

The access it is declared with.

[JsonConverter(typeof(JsonStringEnumConverter<AccessModifier>))]
public AccessModifier Access { get; init; }

Property Value

AccessModifier

AutoInstantiates

The name of the class whose object it is given where code first uses it, for a variable declared As New (AutoInstantiates); null for any other symbol, or when not known.

public string? AutoInstantiates { get; init; }

Property Value

string

Container

What declares it, such as Module1 or VBA.Interaction; null for a module.

public string? Container { get; init; }

Property Value

string

ControlArrayOf

The name of the control array it is an element of, for a control of a VB6 form; null otherwise.

public string? ControlArrayOf { get; init; }

Property Value

string

Declaration

Its declaration as hover writes it, such as Public Function F(ByVal x As Long) As String.

public required string Declaration { get; init; }

Property Value

string

DeclaredType

The name of its declared type; null when it has none, or one that did not resolve.

public string? DeclaredType { get; init; }

Property Value

string

Documentation

The text that documents it (a library member's help string); null when it has none.

public string? Documentation { get; init; }

Property Value

string

Hides

The qualified name of what it hides (QualifiedName); null when it hides nothing, or when not known.

public string? Hides { get; init; }

Property Value

string

Id

The address of the symbol (its SemanticId).

public required Uri Id { get; init; }

Property Value

Uri

IsArray

Whether its declared type is an array.

public bool IsArray { get; init; }

Property Value

bool

IsImplicit

Whether it was never declared: it came into being because code referred to it (IsImplicit); null when not known.

public bool? IsImplicit { get; init; }

Property Value

bool?

Kind

What it is.

public DescribedSymbolKind Kind { get; init; }

Property Value

DescribedSymbolKind

Library

The library that declares it; null for a symbol of the workspace. For a Declared procedure, the library of its module, not its Lib.

public string? Library { get; init; }

Property Value

string

Name

The name it is declared with.

public required string Name { get; init; }

Property Value

string

References

How many times the project's code reads it, writes it and passes it as an argument (References); null when not known.

public DeclarationReferences? References { get; init; }

Property Value

DeclarationReferences?

Role

The part it plays in its module (Role); null when not known.

[JsonConverter(typeof(JsonStringEnumConverter<DeclarationRole>))]
public DeclarationRole? Role { get; init; }

Property Value

DeclarationRole?

Scope

Where it is declared.

public DescribedScope Scope { get; init; }

Property Value

DescribedScope

TypeKind

The kind of its declared type, or of its elements' type for an array (Of(VBType?)); null when it has no type, or one that did not resolve.

[JsonConverter(typeof(JsonStringEnumConverter<DeclaredTypeKind>))]
public DeclaredTypeKind? TypeKind { get; init; }

Property Value

DeclaredTypeKind?