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

XmlFoldingTagger

Class

Tagger class responsible for creating collapsible (folding) regions in XML, XAML and HTML code documents.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Taggers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

public class XmlFoldingTagger : FoldingTaggerBase, ITagger<FoldingRegionTag>

Inheritance: objectTaggerBase<FoldingRegionTag>FoldingTaggerBaseXmlFoldingTagger

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

XmlFoldingTagger(ITextDocumentEditor)

Initializes a new instance of the XmlFoldingTagger class.

public XmlFoldingTagger(ITextDocumentEditor editor)

Parameters:editorITextDocumentEditor

The syntax editor.

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

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

Parameters:startToEndMapDictionary<string, string>

Pairs of start/end collapsible section words.

Returns:

string

The end block pattern.

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

BuildStartRegionBlockPattern(Dictionary<string, string>)

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

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

Parameters:startToEndMapDictionary<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.

protected override Span CoerceFoldingSpan(Span defaultFoldingSpan)

Parameters:defaultFoldingSpanSpan

The default provided folding span.

Returns:

Span

The coerced folding span.

Overrides: FoldingTaggerBase.CoerceFoldingSpan(Span)

GetFoldingRegionTitle(string, Span, string)

Gets the text displayed in the collapsed folding section.

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)

GetFoldingRegionToolTipContent(Span)

Gets the folding region's tooltip content.

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)

RebuildFoldingRegions()

Rebuilds the list of all collapsible (folding) regions.

protected override void RebuildFoldingRegions()

Overrides: FoldingTaggerBase.RebuildFoldingRegions()