TextStudioPlanView
public readonly struct TextStudioPlanViewRead-only semantic plan consumed by renderers and integrations.
Methods
Section titled “Methods”
GetTextUnit(int)
Section titled “GetTextUnit(int)”public TextStudioTextUnit GetTextUnit(int unitIndex)Gets semantic-unit metadata, or a default value for an invalid index.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
TextStudio.TextStudioTextUnit
GetResolvedStart(int)
Section titled “GetResolvedStart(int)”public int GetResolvedStart(int unitIndex)Gets the unit’s start index in resolved plain text.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Int32
GetResolvedLength(int)
Section titled “GetResolvedLength(int)”public int GetResolvedLength(int unitIndex)Gets the unit’s UTF-16 length in resolved plain text.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Int32
GetUnitIndexForResolvedChar(int)
Section titled “GetUnitIndexForResolvedChar(int)”public int GetUnitIndexForResolvedChar(int resolvedCharIndex)Maps a resolved UTF-16 character index to its semantic text unit.
Parameters
| Name | Type |
|---|---|
resolvedCharIndex |
System.Int32 |
Returns
System.Int32
GetUnitIndexForDisplayChar(int)
Section titled “GetUnitIndexForDisplayChar(int)”public int GetUnitIndexForDisplayChar(int displayCharIndex)Maps a display-text UTF-16 index to its semantic text unit, ignoring retained native markup.
Parameters
| Name | Type |
|---|---|
displayCharIndex |
System.Int32 |
Returns
System.Int32
GetResolvedIndexForDisplayChar(int)
Section titled “GetResolvedIndexForDisplayChar(int)”public int GetResolvedIndexForDisplayChar(int displayCharIndex)Maps a display-text UTF-16 index to resolved plain text.
Parameters
| Name | Type |
|---|---|
displayCharIndex |
System.Int32 |
Returns
System.Int32
GetUnitBoundaryForResolvedChar(int)
Section titled “GetUnitBoundaryForResolvedChar(int)”public int GetUnitBoundaryForResolvedChar(int resolvedCharIndex)Maps a resolved character boundary to the corresponding semantic-unit boundary.
Parameters
| Name | Type |
|---|---|
resolvedCharIndex |
System.Int32 |
Returns
System.Int32
GetPrimaryChar(int)
Section titled “GetPrimaryChar(int)”public char GetPrimaryChar(int unitIndex)Gets the first UTF-16 code unit of a semantic unit, or a null character when unavailable.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Char
GetUnitText(int)
Section titled “GetUnitText(int)”public string GetUnitText(int unitIndex)Allocates and returns the resolved substring represented by a semantic unit.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.String
IsWhiteSpaceUnit(int)
Section titled “IsWhiteSpaceUnit(int)”public bool IsWhiteSpaceUnit(int unitIndex)Reports whether every resolved character in a semantic unit is whitespace.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Boolean
IsLineBreakUnit(int)
Section titled “IsLineBreakUnit(int)”public bool IsLineBreakUnit(int unitIndex)Reports whether a semantic unit begins with a line-break character.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Boolean
IsPunctuationUnit(int)
Section titled “IsPunctuationUnit(int)”public bool IsPunctuationUnit(int unitIndex)Reports whether a semantic unit begins with Unicode punctuation.
Parameters
| Name | Type |
|---|---|
unitIndex |
System.Int32 |
Returns
System.Boolean
Properties
Section titled “Properties”
IsCreated
Section titled “IsCreated”public bool IsCreated { get; }Returns
System.Boolean
CanonicalText
Section titled “CanonicalText”public string CanonicalText { get; }Returns
System.String
SourceVersion
Section titled “SourceVersion”public uint SourceVersion { get; }Returns
System.UInt32
ResolvedText
Section titled “ResolvedText”public string ResolvedText { get; }Returns
System.String
DisplayText
Section titled “DisplayText”public string DisplayText { get; }Returns
System.String
TokenCount
Section titled “TokenCount”public int TokenCount { get; }Returns
System.Int32
GlyphRunCount
Section titled “GlyphRunCount”public int GlyphRunCount { get; }Returns
System.Int32
WordCount
Section titled “WordCount”public int WordCount { get; }Returns
System.Int32
LineCount
Section titled “LineCount”public int LineCount { get; }Returns
System.Int32
ParagraphCount
Section titled “ParagraphCount”public int ParagraphCount { get; }Returns
System.Int32
EffectBindingCount
Section titled “EffectBindingCount”public int EffectBindingCount { get; }Returns
System.Int32
CharacterSubstitutionBindingCount
Section titled “CharacterSubstitutionBindingCount”public int CharacterSubstitutionBindingCount { get; }Returns
System.Int32
ActionMarkerCount
Section titled “ActionMarkerCount”public int ActionMarkerCount { get; }Returns
System.Int32
ExtensionTagCount
Section titled “ExtensionTagCount”public int ExtensionTagCount { get; }Returns
System.Int32
InstantRangeCount
Section titled “InstantRangeCount”public int InstantRangeCount { get; }Returns
System.Int32
RegionMapCount
Section titled “RegionMapCount”public int RegionMapCount { get; }Returns
System.Int32
VisibleGlyphCount
Section titled “VisibleGlyphCount”public int VisibleGlyphCount { get; }Returns
System.Int32
TextUnitCount
Section titled “TextUnitCount”public int TextUnitCount { get; }Returns
System.Int32
Tokens
Section titled “Tokens”public TextStudioReadOnlyBuffer<TextToken> Tokens { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.TextToken}
GlyphRuns
Section titled “GlyphRuns”public TextStudioReadOnlyBuffer<GlyphRun> GlyphRuns { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.GlyphRun}
WordRanges
Section titled “WordRanges”public TextStudioReadOnlyBuffer<WordRange> WordRanges { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.WordRange}
LineRanges
Section titled “LineRanges”public TextStudioReadOnlyBuffer<LineRange> LineRanges { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.LineRange}
ParagraphRanges
Section titled “ParagraphRanges”public TextStudioReadOnlyBuffer<ParagraphRange> ParagraphRanges { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.ParagraphRange}
EffectBindings
Section titled “EffectBindings”public TextStudioReadOnlyBuffer<EffectBinding> EffectBindings { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.EffectBinding}
CharacterSubstitutionBindings
Section titled “CharacterSubstitutionBindings”public TextStudioReadOnlyBuffer<CharacterSubstitutionBinding> CharacterSubstitutionBindings { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.CharacterSubstitutionBinding}
ActionMarkers
Section titled “ActionMarkers”public TextStudioReadOnlyBuffer<ActionMarker> ActionMarkers { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.ActionMarker}
ExtensionTags
Section titled “ExtensionTags”public TextStudioReadOnlyBuffer<TextStudioExtensionTag> ExtensionTags { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.TextStudioExtensionTag}
InstantRanges
Section titled “InstantRanges”public TextStudioReadOnlyBuffer<TextStudioInstantRange> InstantRanges { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.TextStudioInstantRange}
RegionMaps
Section titled “RegionMaps”public TextStudioReadOnlyBuffer<RegionToGlyphMap> RegionMaps { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.RegionToGlyphMap}
GlyphToWordIndex
Section titled “GlyphToWordIndex”public TextStudioReadOnlyBuffer<int> GlyphToWordIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
GlyphToLineIndex
Section titled “GlyphToLineIndex”public TextStudioReadOnlyBuffer<int> GlyphToLineIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
GlyphToParagraphIndex
Section titled “GlyphToParagraphIndex”public TextStudioReadOnlyBuffer<int> GlyphToParagraphIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
TextUnits
Section titled “TextUnits”public TextStudioReadOnlyBuffer<TextStudioTextUnit> TextUnits { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.TextStudioTextUnit}
ResolvedCharToTextUnitIndex
Section titled “ResolvedCharToTextUnitIndex”public TextStudioReadOnlyBuffer<int> ResolvedCharToTextUnitIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
DisplayCharToTextUnitIndex
Section titled “DisplayCharToTextUnitIndex”public TextStudioReadOnlyBuffer<int> DisplayCharToTextUnitIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
DisplayCharToResolvedCharIndex
Section titled “DisplayCharToResolvedCharIndex”public TextStudioReadOnlyBuffer<int> DisplayCharToResolvedCharIndex { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{System.Int32}
CharDecorations
Section titled “CharDecorations”public TextStudioReadOnlyBuffer<DecorationBits> CharDecorations { get; }Returns
TextStudio.TextStudioReadOnlyBuffer{TextStudio.DecorationBits}