Table of Contents

Class SignatureParameter

Namespace
RDCore.SDK.Model.Symbols.Completion
Assembly
RDCore.SDK.dll

A parameter of a SignatureDescription: where it is written in the signature's label, and what it is.

public sealed record SignatureParameter : IEquatable<SignatureParameter>
Inheritance
SignatureParameter
Implements
Inherited Members

Constructors

SignatureParameter(string, int, int, bool, string?, VBType?, bool)

A parameter of a SignatureDescription: where it is written in the signature's label, and what it is.

public SignatureParameter(string Name, int Start, int End, bool IsParamArray = false, string? Documentation = null, VBType? Type = null, bool IsOptional = false)

Parameters

Name string

The name of the parameter.

Start int

The offset of the first character of the parameter in the label.

End int

The offset of the character after the parameter in the label.

IsParamArray bool

Whether it is a ParamArray, which takes every argument from where it is on.

Documentation string

What the parameter is, in a sentence: its doc string; null when it has none.

Type VBType

The declared type of the parameter: an argument given to it is let-coerced to it. An Enum's, for one whose arguments are its constants (Buttons As VbMsgBoxStyle), which a completion list offers first; null for a ParamArray, whose arguments are of any type.

IsOptional bool

Whether it is declared Optional: a call need not give it an argument (MS-VBAL §5.3.1.11).

Properties

Documentation

What the parameter is, in a sentence: its doc string; null when it has none.

public string? Documentation { get; init; }

Property Value

string

End

The offset of the character after the parameter in the label.

public int End { get; init; }

Property Value

int

IsOptional

Whether it is declared Optional: a call need not give it an argument (MS-VBAL §5.3.1.11).

public bool IsOptional { get; init; }

Property Value

bool

IsParamArray

Whether it is a ParamArray, which takes every argument from where it is on.

public bool IsParamArray { get; init; }

Property Value

bool

Name

The name of the parameter.

public string Name { get; init; }

Property Value

string

Start

The offset of the first character of the parameter in the label.

public int Start { get; init; }

Property Value

int

Type

The declared type of the parameter: an argument given to it is let-coerced to it. An Enum's, for one whose arguments are its constants (Buttons As VbMsgBoxStyle), which a completion list offers first; null for a ParamArray, whose arguments are of any type.

public VBType? Type { get; init; }

Property Value

VBType

Methods

TextIn(SignatureDescription)

The parameter as the signature's label writes it: Optional ByVal Length As Long.

public string TextIn(SignatureDescription signature)

Parameters

signature SignatureDescription

The signature the parameter is of.

Returns

string