ITextStudioCharacterSubstitution
public interface ITextStudioCharacterSubstitutionDefines a registered markup-driven transformation of presentation glyphs.
Methods
Section titled “Methods”
CanonicalizeParameters(in TextStudioTagParameters)
Section titled “CanonicalizeParameters(in TextStudioTagParameters)”TextStudioTagParameters CanonicalizeParameters(in TextStudioTagParameters parameters)Normalizes authored parameters into the substitution’s canonical form.
Parameters
| Name | Type |
|---|---|
parameters |
TextStudio.TextStudioTagParameters |
Returns
TextStudio.TextStudioTagParameters
CreateRuntime()
Section titled “CreateRuntime()”ITextStudioCharacterSubstitutionRuntime CreateRuntime()Creates isolated mutable state for one host and compiled binding.
Returns
TextStudio.ITextStudioCharacterSubstitutionRuntime
GetCompletionDuration(TextStudioPlanView, in CharacterSubstitutionBinding, ITextStudioRevealState)
Section titled “GetCompletionDuration(TextStudioPlanView, in CharacterSubstitutionBinding, ITextStudioRevealState)”float GetCompletionDuration(TextStudioPlanView plan, in CharacterSubstitutionBinding binding, ITextStudioRevealState reveal)Calculates how long the substitution remains active after its glyphs are revealed.
Parameters
| Name | Type |
|---|---|
plan |
TextStudio.TextStudioPlanView |
binding |
TextStudio.CharacterSubstitutionBinding |
reveal |
TextStudio.ITextStudioRevealState |
Returns
System.Single: Duration in seconds, or 0 when no completion delay is required.
Properties
Section titled “Properties”
string Id { get; }Returns
System.String
Definition
Section titled “Definition”TextStudioCharacterSubstitutionDefinition Definition { get; }Returns
TextStudio.TextStudioCharacterSubstitutionDefinition