TextStudioExtensions
public static class TextStudioExtensionsRegisters and resolves extension tags, character substitutions, and tag expansions.
Methods
Section titled “Methods”
RegisterTag(TextStudioExtensionTagDefinition)
Section titled “RegisterTag(TextStudioExtensionTagDefinition)”public static bool RegisterTag(TextStudioExtensionTagDefinition definition)Register an extension tag definition.
Parameters
| Name | Type |
|---|---|
definition |
TextStudio.TextStudioExtensionTagDefinition |
Returns
System.Boolean
TryGetTag(string, out TextStudioExtensionTagDefinition)
Section titled “TryGetTag(string, out TextStudioExtensionTagDefinition)”public static bool TryGetTag(string id, out TextStudioExtensionTagDefinition definition)Resolve an extension tag definition by identifier or alias.
Parameters
| Name | Type |
|---|---|
id |
System.String |
definition |
TextStudio.TextStudioExtensionTagDefinition |
Returns
System.Boolean
UnregisterTags(string)
Section titled “UnregisterTags(string)”public static void UnregisterTags(string ownerId)Remove every extension tag registered by one owner.
Parameters
| Name | Type |
|---|---|
ownerId |
System.String |
RegisterCharacterSubstitution(ITextStudioCharacterSubstitution)
Section titled “RegisterCharacterSubstitution(ITextStudioCharacterSubstitution)”public static void RegisterCharacterSubstitution(ITextStudioCharacterSubstitution substitution)Register a presentation-layer character substitution in the runtime tier.
Parameters
| Name | Type |
|---|---|
substitution |
TextStudio.ITextStudioCharacterSubstitution |
TryGetCharacterSubstitution(string, out ITextStudioCharacterSubstitution)
Section titled “TryGetCharacterSubstitution(string, out ITextStudioCharacterSubstitution)”public static bool TryGetCharacterSubstitution(string id, out ITextStudioCharacterSubstitution substitution)Resolve a character substitution by identifier or alias without logging.
Parameters
| Name | Type |
|---|---|
id |
System.String |
substitution |
TextStudio.ITextStudioCharacterSubstitution |
Returns
System.Boolean
UnregisterCharacterSubstitution(string)
Section titled “UnregisterCharacterSubstitution(string)”public static bool UnregisterCharacterSubstitution(string id)Remove the highest-priority user-owned character substitution.
Parameters
| Name | Type |
|---|---|
id |
System.String |
Returns
System.Boolean
RegisterTagExpansionSheet(TextStudioTagExpansionSheet)
Section titled “RegisterTagExpansionSheet(TextStudioTagExpansionSheet)”public static void RegisterTagExpansionSheet(TextStudioTagExpansionSheet sheet)Register every tag expansion entry from a sheet in the runtime tier.
Parameters
| Name | Type |
|---|---|
sheet |
TextStudio.TextStudioTagExpansionSheet |
RegisterTagExpansion(TextStudioTagExpansionEntry)
Section titled “RegisterTagExpansion(TextStudioTagExpansionEntry)”public static void RegisterTagExpansion(TextStudioTagExpansionEntry entry)Register one tag expansion entry in the runtime tier.
Parameters
| Name | Type |
|---|---|
entry |
TextStudio.TextStudioTagExpansionEntry |
UnregisterTagExpansion(string)
Section titled “UnregisterTagExpansion(string)”public static bool UnregisterTagExpansion(string tagId)Remove the highest-priority user-owned tag expansion.
Parameters
| Name | Type |
|---|---|
tagId |
System.String |
Returns
System.Boolean