Class
LineHighlightTagger

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:

cs-api-definition
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.

Declaration

cs-api-definition
public LineHighlightTagger(RadSyntaxEditor editor, ITextFormatDefinitionKey formatDefinitionKey)

Parameters

editor

RadSyntaxEditor

formatDefinitionKey

ITextFormatDefinitionKey

Fields

LineHighlightFormatDefinition

The line highlight format definition.

Declaration

cs-api-definition
public static readonly ITextFormatDefinitionKey LineHighlightFormatDefinition

Field Value

ITextFormatDefinitionKey

Properties

HighlightMode

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

Declaration

cs-api-definition
public LineHighlightMode HighlightMode { get; set; }

Property Value

LineHighlightMode

Methods

GetTags(NormalizedSnapshotSpanCollection)

Gets a collection of TextHighlightTag tags.

Declaration

cs-api-definition
public override IEnumerable<TagSpan<TextHighlightTag>> GetTags(NormalizedSnapshotSpanCollection spans)

Parameters

spans

NormalizedSnapshotSpanCollection

Returns

IEnumerable<TagSpan<TextHighlightTag>>

Overrides TaggerBase<TextHighlightTag>.GetTags(NormalizedSnapshotSpanCollection)

HighlightLines(IEnumerable<int>)

Updates the highlighted lines.

Declaration

cs-api-definition
public void HighlightLines(IEnumerable<int> lines)

Parameters

lines

IEnumerable<int>

The lines to highlight.