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

LineHighlightTagger

Class

Class LineHighlightTagger which prepares collection of TextHighlightTags for a collection of lines.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Tagging.Taggers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

public class LineHighlightTagger : TaggerBase<TextHighlightTag>, ITagger<TextHighlightTag>

Inheritance: objectTaggerBase<TextHighlightTag>LineHighlightTagger

Implements: ITagger<TextHighlightTag>

Inherited Members TaggerBase<TextHighlightTag>.CallOnTagsChanged(Span)TaggerBase<TextHighlightTag>.OnTagsChanged(TagsChangedEventArgs)TaggerBase<TextHighlightTag>.EditorTaggerBase<TextHighlightTag>.DocumentTaggerBase<TextHighlightTag>.TagsChanged

Constructors

LineHighlightTagger(RadSyntaxEditor, ITextFormatDefinitionKey)

Initializes a new instance of the LineHighlightTagger class.

public LineHighlightTagger(RadSyntaxEditor editor, ITextFormatDefinitionKey formatDefinitionKey)

Parameters:editorRadSyntaxEditorformatDefinitionKeyITextFormatDefinitionKey

Fields

LineHighlightFormatDefinition

ITextFormatDefinitionKey

The line highlight format definition.

public static readonly ITextFormatDefinitionKey LineHighlightFormatDefinition

Properties

HighlightMode

LineHighlightMode

Determines what part of the line will be highlighted by the tagger.

public LineHighlightMode HighlightMode { get; set; }

Methods

GetTags(NormalizedSnapshotSpanCollection)

Gets a collection of TextHighlightTag tags.

public override IEnumerable<TagSpan<TextHighlightTag>> GetTags(NormalizedSnapshotSpanCollection spans)

Parameters:spansNormalizedSnapshotSpanCollectionReturns:

IEnumerable<TagSpan<TextHighlightTag>>

Overrides: TaggerBase<TextHighlightTag>.GetTags(NormalizedSnapshotSpanCollection)

HighlightLines(IEnumerable<int>)

Updates the highlighted lines.

public void HighlightLines(IEnumerable<int> lines)

Parameters:linesIEnumerable<int>

The lines to highlight.