TextStudioTagParameterDefinition

ClassTextStudioTextStudio

public sealed class TextStudioTagParameterDefinition

Parameter name, aliases, type, requirement, operation support, and suggestion metadata for a tag.

Constructors

TextStudioTagParameterDefinition(string, TextStudioTagParameterKind, bool, int, string, string, string, string[], string[])

public TextStudioTagParameterDefinition(string name, TextStudioTagParameterKind kind = TextStudioTagParameterKind.String, bool required = false, int positionalIndex = -1, string displayName = null, string description = null, string suggestionKey = null, string[] allowedValues = null, string[] aliases = null)

Creates a parameter schema with normalized names, aliases, examples, and suggestions.

Parameters

Name	Type
name	System.String
kind	TextStudio.TextStudioTagParameterKind
required	System.Boolean
positionalIndex	System.Int32
displayName	System.String
description	System.String
suggestionKey	System.String
allowedValues	System.String[]
aliases	System.String[]

Methods

MatchesName(string)

public bool MatchesName(string name)

Matches the canonical parameter name or an alias using ordinal case-insensitive comparison.

Parameters

Name	Type
name	System.String

Returns

System.Boolean

Properties

Name

public string Name { get; }

Returns

System.String

DisplayName

public string DisplayName { get; }

Returns

System.String

Description

public string Description { get; }

Returns

System.String

Kind

public TextStudioTagParameterKind Kind { get; }

Returns

TextStudio.TextStudioTagParameterKind

Required

public bool Required { get; }

Returns

System.Boolean

PositionalIndex

public int PositionalIndex { get; }

Returns

System.Int32

SuggestionKey

public string SuggestionKey { get; }

Returns

System.String

AllowedValues

public IReadOnlyList<string> AllowedValues { get; }

Returns

System.Collections.Generic.IReadOnlyList{System.String}

Aliases

public IReadOnlyList<string> Aliases { get; }

Returns

System.Collections.Generic.IReadOnlyList{System.String}