TextStudioCharacterSubstitutionDefinition

ClassTextStudioTextStudio

public sealed class TextStudioCharacterSubstitutionDefinition

Metadata, aliases, examples, and parameter schema for one substitution tag.

Constructors

TextStudioCharacterSubstitutionDefinition(string, string, string, string[], string[], TextStudioTagParameterDefinition[])

public TextStudioCharacterSubstitutionDefinition(string id, string displayName = null, string description = null, string[] aliases = null, string[] examples = null, TextStudioTagParameterDefinition[] parameters = null)

Creates a discoverable substitution definition with defensive empty defaults.

Parameters

Name	Type
id	System.String
displayName	System.String
description	System.String
aliases	System.String[]
examples	System.String[]
parameters	TextStudio.TextStudioTagParameterDefinition[]

Properties

Id

public string Id { get; }

Returns

System.String

DisplayName

public string DisplayName { get; }

Returns

System.String

Description

public string Description { get; }

Returns

System.String

Aliases

public IReadOnlyList<string> Aliases { get; }

Returns

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

Examples

public IReadOnlyList<string> Examples { get; }

Returns

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

Parameters

public IReadOnlyList<TextStudioTagParameterDefinition> Parameters { get; }

Returns

System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioTagParameterDefinition}