New to Telerik UI for WPF? Start a free 30-day trial

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:

C#
public class BracketFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Inheritance: objectTaggerBase<FoldingRegionTag>FoldingTaggerBaseBracketFoldingTagger

Derived Classes: CSharpFoldingTaggerSquareBracketFoldingTaggerJavaScriptFoldingTagger

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

Initializes a new instance of the BracketFoldingTagger class.

C#
public BracketFoldingTagger(ITextDocumentEditor editor)
Parameters:editorITextDocumentEditor

The editor.

Properties

Gets or sets the closing section symbol.

C#
public char ClosingBracket { get; set; }

Gets or sets the opening section symbol.

C#
public char OpeningBracket { get; set; }

Methods

Rebuilds the bracket folding sections.

C#
protected virtual void BuildBracketFoldings(string inputValue)
Parameters:inputValuestring

Gets the text displayed in the collapsed folding section.

C#
protected override string GetFoldingRegionTitle(string inputValue, Span span, string startText)
Parameters:inputValuestring

The document string.

spanSpan

The span defining the folded region.

startTextstring

The start text of the collapsible (folding) section.

Returns:

string

The region title.

Overrides: FoldingTaggerBase.GetFoldingRegionTitle(string, Span, string)

Gets the folding region's tooltip content.

C#
protected override string GetFoldingRegionToolTipContent(Span foldingSpan)
Parameters:foldingSpanSpan

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

Returns:

string

The tooltip content.

Overrides: FoldingTaggerBase.GetFoldingRegionToolTipContent(Span)

Rebuilds the list of all collapsible (folding) regions.

C#
protected override void RebuildFoldingRegions()

Overrides: FoldingTaggerBase.RebuildFoldingRegions()