Class SignatureDescription

Namespace

RDCore.SDK.Model.Symbols.Completion

Assembly

RDCore.SDK.dll

What a procedure takes, as a signature help shows it (LSP 3.17 §Signature Help): its signature on one line - Function Left(String As Variant, Length As Long) As Variant - each of its parameters where the line has it, and what the procedure does.

public sealed record SignatureDescription : IEquatable<SignatureDescription>

Inheritance

object

SignatureDescription

Implements

IEquatable<SignatureDescription>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The implicit Me of an instance member is none of its parameters: it is the object the member is called on, and no argument is written for it.

Constructors

SignatureDescription(string, IReadOnlyList<SignatureParameter>, string?)

What a procedure takes, as a signature help shows it (LSP 3.17 §Signature Help): its signature on one line - Function Left(String As Variant, Length As Long) As Variant - each of its parameters where the line has it, and what the procedure does.

public SignatureDescription(string Label, IReadOnlyList<SignatureParameter> Parameters, string? Documentation = null)

Parameters

Label string

The signature, on one line.

Parameters IReadOnlyList<SignatureParameter>

The parameters, in the order they are declared.

Documentation string

What the procedure does, in a sentence: its doc string (DocString); null when it has none.

Remarks

The implicit Me of an instance member is none of its parameters: it is the object the member is called on, and no argument is written for it.

Properties

Documentation

What the procedure does, in a sentence: its doc string (DocString); null when it has none.

public string? Documentation { get; init; }

Property Value

string

Label

The signature, on one line.

public string Label { get; init; }

Property Value

string

Parameters

The parameters, in the order they are declared.

public IReadOnlyList<SignatureParameter> Parameters { get; init; }

Property Value

IReadOnlyList<SignatureParameter>

Methods

ActiveParameterOf(int, string?)

The parameter an argument is given to: the one it names, or the one at its position - the ParamArray for every argument from where it is on.

public int? ActiveParameterOf(int argumentIndex, string? argumentName = null)

Parameters

argumentIndex int

The position of the argument, from 0.

argumentName string

The name a named argument is written with (Prompt:=); null for one that is not named.

Returns

int?

The index of the parameter; null when the argument is given to none.

Of(Symbol)

The signature of a procedure, a function or a property; null for a symbol that is not called.

public static SignatureDescription? Of(Symbol symbol)

Parameters

symbol Symbol

The symbol.

Returns

SignatureDescription

ToSignatureInformation(int?)

The signature as LSP has it: each parameter by where it is in the label.

public SignatureInformation ToSignatureInformation(int? activeParameter = null)

Parameters

activeParameter int?

The parameter the argument at the cursor is given to (ActiveParameterOf(int, string?)).

Returns

SignatureInformation