Class
VisualBasicFoldingTagger

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

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Taggers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

cs-api-definition

public class VisualBasicFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Inheritance: objectTaggerBase<FoldingRegionTag>FoldingTaggerBaseVisualBasicFoldingTagger

Implements: ITagger<FoldingRegionTag>

Inherited Members FoldingTaggerBase.GetTags(NormalizedSnapshotSpanCollection)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

VisualBasicFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the VisualBasicFoldingTagger class.

Declaration

cs-api-definition

public VisualBasicFoldingTagger(ITextDocumentEditor editor)

Parameters

editor

ITextDocumentEditor

The syntax editor.

Methods

BuildCommentsSectionFoldedRegions()

Builds the multiline comment folding regions. Linear iteration of lines, linear iteration of single line because Regex matching slows down the performance.

Declaration

cs-api-definition

protected virtual void BuildCommentsSectionFoldedRegions()

BuildEndRegionBlockPattern(Dictionary<string, string>)

Prepares patters for matching end of collapsible folding section. Default implementation is to join all end strings of provided collapsible sections. Example for end words End and Finish, pattern is "End|Finish".

Declaration

cs-api-definition

protected override string BuildEndRegionBlockPattern(Dictionary<string, string> startToEndMap)

Parameters

startToEndMap

Dictionary<string, string>

Pairs of start/end collapsible section words.

Returns

string

The end block pattern.

Overrides FoldingTaggerBase.BuildEndRegionBlockPattern(Dictionary<string, string>)

BuildImportsFoldingRegion()

Builds the 'Imports' folding region.

Declaration

cs-api-definition

protected virtual void BuildImportsFoldingRegion()

BuildStartRegionBlockPattern(Dictionary<string, string>)

Prepares patters for matching start of collapsible folding section. Default implementation is to join all start strings of Visual Basic collapsible sections. Start strings pattern is excluding End words. Example for start words Sub, Get and Class, pattern is "\b(?<!End )Sub\b|\b(?<!End )Get\b(?<!End )Class\b".

Declaration

cs-api-definition

protected override string BuildStartRegionBlockPattern(Dictionary<string, string> startToEndMap)

Parameters

startToEndMap

Dictionary<string, string>

Pairs of start/end collapsible section words.

Returns

string

The start block pattern.

Overrides FoldingTaggerBase.BuildStartRegionBlockPattern(Dictionary<string, string>)

CoerceFoldingSpan(Span)

Coerces the default provided folding span - span starting from the start of the region's start text and ending in the end of the region's end text.

Declaration

cs-api-definition

protected override Span CoerceFoldingSpan(Span defaultFoldingSpan)

Parameters

defaultFoldingSpan

Span

The default provided folding span.

Returns

Span

The coerced folding span.

Overrides FoldingTaggerBase.CoerceFoldingSpan(Span)

CoerceImportsSectionSpan(Span)

Coerces the default Imports folding region's span.

Declaration

cs-api-definition

protected virtual Span CoerceImportsSectionSpan(Span defaultImportsSpan)

Parameters

defaultImportsSpan

Span

Default Imports region span is from the end of the first Import word to the end of the line containing the last Imports 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 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)

GetImportsToolTipContent(Span)

Gets the Imports folding region's tooltip content.

Declaration

cs-api-definition

protected virtual string GetImportsToolTipContent(Span importsSpan)

Parameters

importsSpan

Span

Span containing the imports section.

Returns

string

The tooltip content.

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

Declaration

cs-api-definition

protected override void RebuildFoldingRegions()

Overrides FoldingTaggerBase.RebuildFoldingRegions()

ClassVisualBasicFoldingTagger

Class
VisualBasicFoldingTagger