Class
CSharpFoldingTagger

Tagger class responsible for creating collapsible (folding) regions in CSharp code document.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Taggers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

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

Inheritance: objectTaggerBase<FoldingRegionTag>FoldingTaggerBaseBracketFoldingTaggerCSharpFoldingTagger

Implements: ITagger<FoldingRegionTag>

Inherited Members BracketFoldingTagger.BuildBracketFoldings(string)BracketFoldingTagger.OpeningBracketBracketFoldingTagger.ClosingBracketFoldingTaggerBase.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

CSharpFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the CSharpFoldingTagger class.

Declaration

cs-api-definition
public CSharpFoldingTagger(ITextDocumentEditor editor)

Parameters

editor

ITextDocumentEditor

The syntax editor.

Methods

BuildCommentsSectionFoldedRegions()

Builds the multiline comment folding regions.

Declaration

cs-api-definition
protected virtual void BuildCommentsSectionFoldedRegions()

BuildUsingSectionFoldedRegion()

Builds the 'usings' folding region.

Declaration

cs-api-definition
protected virtual void BuildUsingSectionFoldedRegion()

BuildUsingSectionToolTipContent(Span)

Gets the 'usings' folding region's tooltip content.

Declaration

cs-api-definition
protected virtual string BuildUsingSectionToolTipContent(Span usingSpan)

Parameters

usingSpan

Span

Span containing the usings section.

Returns

string

The tooltip content.

CoerceUsingSectionSpan(Span)

Coerces the default 'usings' folding region's span.

Declaration

cs-api-definition
protected virtual Span CoerceUsingSectionSpan(Span defaultUsingSpan)

Parameters

defaultUsingSpan

Span

Default 'usings' region span is from the end of the first using word to the end of the line containing the last using word.

Returns

Span

The coerced span.

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 BracketFoldingTagger.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 BracketFoldingTagger.GetFoldingRegionToolTipContent(Span)

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

Declaration

cs-api-definition
protected override void RebuildFoldingRegions()

Overrides BracketFoldingTagger.RebuildFoldingRegions()