TextStudioExtensionTagDefinition
public sealed class TextStudioExtensionTagDefinitionImmutable schema and dispatch policy for a registered extension tag.
Constructors
Section titled “Constructors”
TextStudioExtensionTagDefinition(string, string, string, string, TextStudioExtensionTagShape, TextStudioExtensionTagDispatch, string[], bool, string[], TextStudioTagParameterDefinition[])
Section titled “TextStudioExtensionTagDefinition(string, string, string, string, TextStudioExtensionTagShape, TextStudioExtensionTagDispatch, string[], bool, string[], TextStudioTagParameterDefinition[])”public TextStudioExtensionTagDefinition(string id, string ownerId, string displayName = null, string description = null, TextStudioExtensionTagShape shape = TextStudioExtensionTagShape.Point, TextStudioExtensionTagDispatch dispatch = TextStudioExtensionTagDispatch.Plan | TextStudioExtensionTagDispatch.Reveal, string[] aliases = null, bool allowAliasOverride = false, string[] examples = null, TextStudioTagParameterDefinition[] parameters = null)Creates a definition used for parsing, validation, discovery, and dispatch.
Parameters
| Name | Type |
|---|---|
id |
System.String |
ownerId |
System.String |
displayName |
System.String |
description |
System.String |
shape |
TextStudio.TextStudioExtensionTagShape |
dispatch |
TextStudio.TextStudioExtensionTagDispatch |
aliases |
System.String[] |
allowAliasOverride |
System.Boolean |
examples |
System.String[] |
parameters |
TextStudio.TextStudioTagParameterDefinition[] |
Properties
Section titled “Properties”
public string Id { get; }Returns
System.String
OwnerId
Section titled “OwnerId”public string OwnerId { get; }Returns
System.String
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Returns
System.String
Description
Section titled “Description”public string Description { get; }Returns
System.String
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}
public TextStudioExtensionTagShape Shape { get; }Returns
TextStudio.TextStudioExtensionTagShape
Dispatch
Section titled “Dispatch”public TextStudioExtensionTagDispatch Dispatch { get; }Returns
TextStudio.TextStudioExtensionTagDispatch
AllowAliasOverride
Section titled “AllowAliasOverride”public bool AllowAliasOverride { get; }Returns
System.Boolean
DispatchesOnPlan
Section titled “DispatchesOnPlan”public bool DispatchesOnPlan { get; }Returns
System.Boolean
DispatchesOnReveal
Section titled “DispatchesOnReveal”public bool DispatchesOnReveal { get; }Returns
System.Boolean
FlushesOnSkip
Section titled “FlushesOnSkip”public bool FlushesOnSkip { get; }Returns
System.Boolean