Class VisualBasicFoldingTagger

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

Inheritance

System.Object

TaggerBase<FoldingRegionTag>

FoldingTaggerBase

VisualBasicFoldingTagger

Inherited Members

FoldingTaggerBase.GetTags(NormalizedSnapshotSpanCollection)

FoldingTaggerBase.ProcessNotMatchedTags(IEnumerable<FoldingRegionMatch>, IEnumerable<FoldingRegionMatch>)

FoldingTaggerBase.InvalidateFoldingRegions()

FoldingTaggerBase.RefreshStartEndMap()

FoldingTaggerBase.FoldingRegionDefinitions

FoldingTaggerBase.IsMatchingCaseSensitive

FoldingTaggerBase.RegionsStartToEndMap

FoldingTaggerBase.FoldingRegionTags

TaggerBase<FoldingRegionTag>.CallOnTagsChanged(Span)

TaggerBase<FoldingRegionTag>.OnTagsChanged(TagsChangedEventArgs)

TaggerBase<FoldingRegionTag>.Editor

TaggerBase<FoldingRegionTag>.Document

TaggerBase<FoldingRegionTag>.TagsChanged

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 VisualBasicFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Constructors

VisualBasicFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the VisualBasicFoldingTagger class.

Declaration

public VisualBasicFoldingTagger(ITextDocumentEditor editor)

Parameters

ITextDocumentEditor editor 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

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

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

Parameters

System.Collections.Generic.Dictionary<System.String, System.String> startToEndMap Pairs of start/end collapsible section words.

Returns

System.String The end block pattern.

Overrides

FoldingTaggerBase.BuildEndRegionBlockPattern(Dictionary<String, String>)

BuildImportsFoldingRegion()

Builds the 'Imports' folding region.

Declaration

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

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

Parameters

System.Collections.Generic.Dictionary<System.String, System.String> startToEndMap Pairs of start/end collapsible section words.

Returns

System.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

protected override Span CoerceFoldingSpan(Span defaultFoldingSpan)

Parameters

Span defaultFoldingSpan 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

protected virtual Span CoerceImportsSectionSpan(Span defaultImportsSpan)

Parameters

Span defaultImportsSpan 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

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

FoldingTaggerBase.GetFoldingRegionTitle(String, Span, String)

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

FoldingTaggerBase.GetFoldingRegionToolTipContent(Span)

GetImportsToolTipContent(Span)

Gets the Imports folding region's tooltip content.

Declaration

protected virtual string GetImportsToolTipContent(Span importsSpan)

Parameters

Span importsSpan Span containing the imports section.

Returns

System.String The tooltip content.

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

Declaration

protected override void RebuildFoldingRegions()

Overrides

FoldingTaggerBase.RebuildFoldingRegions()

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)