Class
BracketFoldingTagger

Tagger class responsible for creating collapsible (folding) regions in code document. Collapsible section is defined with opening and closing bracket symbols.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Taggers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

cs-api-definition
public class BracketFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Inheritance: objectTaggerBase<FoldingRegionTag>FoldingTaggerBaseBracketFoldingTagger

Derived Classes: CSharpFoldingTaggerJavaScriptFoldingTagger

Implements: ITagger<FoldingRegionTag>

Inherited Members FoldingTaggerBase.GetTags(NormalizedSnapshotSpanCollection)FoldingTaggerBase.BuildStartRegionBlockPattern(Dictionary<string, string>)FoldingTaggerBase.BuildEndRegionBlockPattern(Dictionary<string, string>)FoldingTaggerBase.CoerceFoldingSpan(Span)FoldingTaggerBase.ProcessNotMatchedTags(IEnumerable<FoldingRegionMatch>, IEnumerable<FoldingRegionMatch>)FoldingTaggerBase.InvalidateFoldingRegions()FoldingTaggerBase.RefreshStartEndMap()FoldingTaggerBase.FoldingRegionDefinitionsFoldingTaggerBase.IsMatchingCaseSensitiveFoldingTaggerBase.RegionsStartToEndMapFoldingTaggerBase.FoldingRegionTagsTaggerBase<FoldingRegionTag>.CallOnTagsChanged(Span)TaggerBase<FoldingRegionTag>.OnTagsChanged(TagsChangedEventArgs)TaggerBase<FoldingRegionTag>.EditorTaggerBase<FoldingRegionTag>.DocumentTaggerBase<FoldingRegionTag>.TagsChanged

Constructors

BracketFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the BracketFoldingTagger class.

Declaration

cs-api-definition
public BracketFoldingTagger(ITextDocumentEditor editor)

Parameters

editor

ITextDocumentEditor

The editor.

Properties

ClosingBracket

Gets or sets the closing section symbol.

Declaration

cs-api-definition
public char ClosingBracket { get; set; }

Property Value

char

OpeningBracket

Gets or sets the opening section symbol.

Declaration

cs-api-definition
public char OpeningBracket { get; set; }

Property Value

char

Methods

BuildBracketFoldings(string)

Rebuilds the bracket folding sections.

Declaration

cs-api-definition
protected virtual void BuildBracketFoldings(string inputValue)

Parameters

inputValue

string

GetFoldingRegionTitle(string, Span, string)

Gets the text displayed in the collapsed folding section.

Declaration

cs-api-definition
protected override string GetFoldingRegionTitle(string inputValue, Span span, string startText)

Parameters

inputValue

string

The document string.

span

Span

The span defining the folded region.

startText

string

The start text of the collapsible (folding) section.

Returns

string

The region title.

Overrides FoldingTaggerBase.GetFoldingRegionTitle(string, Span, string)

GetFoldingRegionToolTipContent(Span)

Gets the folding region's tooltip content.

Declaration

cs-api-definition
protected override string GetFoldingRegionToolTipContent(Span foldingSpan)

Parameters

foldingSpan

Span

The span starting from the regions' start text and ending after the regions' end text.

Returns

string

The tooltip content.

Overrides FoldingTaggerBase.GetFoldingRegionToolTipContent(Span)

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

Declaration

cs-api-definition
protected override void RebuildFoldingRegions()

Overrides FoldingTaggerBase.RebuildFoldingRegions()