TextStudioTagDefinition
public sealed class TextStudioTagDefinitionImmutable discovery and validation schema for one built-in, native, action, or extension tag.
Constructors
Section titled “Constructors”
TextStudioTagDefinition(string, TextStudioTagKind, string, string, string, TextStudioTagShape, TextStudioTagOwnership, TextStudioTagBackend, TextStudioTagParameterRequirement, string, string, string[], string[], TextStudioTagParameterDefinition[], TextStudioRenderDomain)
Section titled “TextStudioTagDefinition(string, TextStudioTagKind, string, string, string, TextStudioTagShape, TextStudioTagOwnership, TextStudioTagBackend, TextStudioTagParameterRequirement, string, string, string[], string[], TextStudioTagParameterDefinition[], TextStudioRenderDomain)”public TextStudioTagDefinition(string id, TextStudioTagKind kind, string category, string displayName = null, string description = null, TextStudioTagShape shape = TextStudioTagShape.Range, TextStudioTagOwnership ownership = TextStudioTagOwnership.ConsumedByTextStudio, TextStudioTagBackend backendSupport = TextStudioTagBackend.All, TextStudioTagParameterRequirement parameterRequirement = TextStudioTagParameterRequirement.Any, string ownerId = null, string ownerDisplayName = null, string[] aliases = null, string[] examples = null, TextStudioTagParameterDefinition[] parameters = null, TextStudioRenderDomain supportedRenderDomains = TextStudioRenderDomain.All)Creates a complete immutable tag definition for discovery and diagnostics.
Parameters
| Name | Type |
|---|---|
id |
System.String |
kind |
TextStudio.TextStudioTagKind |
category |
System.String |
displayName |
System.String |
description |
System.String |
shape |
TextStudio.TextStudioTagShape |
ownership |
TextStudio.TextStudioTagOwnership |
backendSupport |
TextStudio.TextStudioTagBackend |
parameterRequirement |
TextStudio.TextStudioTagParameterRequirement |
ownerId |
System.String |
ownerDisplayName |
System.String |
aliases |
System.String[] |
examples |
System.String[] |
parameters |
TextStudio.TextStudioTagParameterDefinition[] |
supportedRenderDomains |
TextStudio.TextStudioRenderDomain |
Methods
Section titled “Methods”
SupportsBackend(TextStudioTagBackend)
Section titled “SupportsBackend(TextStudioTagBackend)”public bool SupportsBackend(TextStudioTagBackend backend)Reports whether the tag is valid for the requested authoring backend.
Parameters
| Name | Type |
|---|---|
backend |
TextStudio.TextStudioTagBackend |
Returns
System.Boolean
MatchesParameterState(bool)
Section titled “MatchesParameterState(bool)”public bool MatchesParameterState(bool hasParameter)Reports whether the tag’s parameter requirement permits the supplied parameter presence.
Parameters
| Name | Type |
|---|---|
hasParameter |
System.Boolean |
Returns
System.Boolean
GetPositionalParameter(int)
Section titled “GetPositionalParameter(int)”public TextStudioTagParameterDefinition GetPositionalParameter(int index)Gets the positional schema for an index, including a repeatable tail when configured.
Parameters
| Name | Type |
|---|---|
index |
System.Int32 |
Returns
TextStudio.TextStudioTagParameterDefinition
GetNamedParameter(string)
Section titled “GetNamedParameter(string)”public TextStudioTagParameterDefinition GetNamedParameter(string name)Gets a named schema by case-insensitive canonical name or alias.
Parameters
| Name | Type |
|---|---|
name |
System.String |
Returns
TextStudio.TextStudioTagParameterDefinition
Properties
Section titled “Properties”
public string Id { get; }Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Returns
System.String
Category
Section titled “Category”public string Category { get; }Returns
System.String
OwnerId
Section titled “OwnerId”public string OwnerId { get; }Returns
System.String
OwnerDisplayName
Section titled “OwnerDisplayName”public string OwnerDisplayName { get; }Returns
System.String
Description
Section titled “Description”public string Description { get; }Returns
System.String
public TextStudioTagKind Kind { get; }Returns
TextStudio.TextStudioTagKind
SemanticCategory
Section titled “SemanticCategory”public TextStudioTagCategory SemanticCategory { get; }Returns
TextStudio.TextStudioTagCategory
public TextStudioTagShape Shape { get; }Returns
TextStudio.TextStudioTagShape
Ownership
Section titled “Ownership”public TextStudioTagOwnership Ownership { get; }Returns
TextStudio.TextStudioTagOwnership
BackendSupport
Section titled “BackendSupport”public TextStudioTagBackend BackendSupport { get; }Returns
TextStudio.TextStudioTagBackend
ParameterRequirement
Section titled “ParameterRequirement”public TextStudioTagParameterRequirement ParameterRequirement { get; }Returns
TextStudio.TextStudioTagParameterRequirement
SupportedRenderDomains
Section titled “SupportedRenderDomains”public TextStudioRenderDomain SupportedRenderDomains { get; }Returns
TextStudio.TextStudioRenderDomain
Aliases
Section titled “Aliases”public IReadOnlyList<string> Aliases { get; }Returns
System.Collections.Generic.IReadOnlyList{System.String}
Examples
Section titled “Examples”public IReadOnlyList<string> Examples { get; }Returns
System.Collections.Generic.IReadOnlyList{System.String}
Parameters
Section titled “Parameters”public IReadOnlyList<TextStudioTagParameterDefinition> Parameters { get; }Returns
System.Collections.Generic.IReadOnlyList{TextStudio.TextStudioTagParameterDefinition}