Class BracketFoldingTagger

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

Inheritance
System.Object
TaggerBase<FoldingRegionTag>
FoldingTaggerBase
BracketFoldingTagger
SquareBracketFoldingTagger
CSharpFoldingTagger
JavaScriptFoldingTagger
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Controls.SyntaxEditor.Taggers
Assembly: Telerik.WinControls.SyntaxEditor.dll

Syntax

public class BracketFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Constructors

BracketFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the BracketFoldingTagger class.

Declaration
public BracketFoldingTagger(ITextDocumentEditor editor)
Parameters
ITextDocumentEditor editor

The editor.

Properties

ClosingBracket

Gets or sets the closing section symbol.

Declaration
public char ClosingBracket { get; set; }
Property Value
System.Char

OpeningBracket

Gets or sets the opening section symbol.

Declaration
public char OpeningBracket { get; set; }
Property Value
System.Char

Methods

BuildBracketFoldings(String)

Rebuilds the bracket folding sections.

Declaration
protected virtual void BuildBracketFoldings(string inputValue)
Parameters
System.String inputValue

GetFoldingRegionTitle(String, Span, String)

Gets the text displayed in the collapsed folding section.

Declaration
protected override string GetFoldingRegionTitle(string inputValue, Span span, string startText)
Parameters
System.String inputValue

The document string.
Span span

The span defining the folded region.
System.String startText

The start text of the collapsible (folding) section.
Returns
System.String

The region title.
Overrides

GetFoldingRegionToolTipContent(Span)

Gets the folding region's tooltip content.

Declaration
protected override string GetFoldingRegionToolTipContent(Span foldingSpan)
Parameters
Span foldingSpan

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

The tooltip content.
Overrides

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

Declaration
protected override void RebuildFoldingRegions()
Overrides

Extension Methods