Documentation

Class LineHighlightTagger

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

Inheritance
System.Object
TaggerBase<TextHighlightTag>
LineHighlightTagger
Inherited Members
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 LineHighlightTagger : TaggerBase<TextHighlightTag>, ITagger<TextHighlightTag>

Constructors

LineHighlightTagger(RadSyntaxEditorElement, ITextFormatDefinitionKey)

Initializes a new instance of the LineHighlightTagger class.

Declaration
public LineHighlightTagger(RadSyntaxEditorElement editor, ITextFormatDefinitionKey formatDefinitionKey)
Parameters
RadSyntaxEditorElement editor

ITextFormatDefinitionKey formatDefinitionKey

Fields

LineHighlightFormatDefinition

The line highlight format definition.

Declaration
public static readonly ITextFormatDefinitionKey LineHighlightFormatDefinition
Field Value
ITextFormatDefinitionKey

Properties

HighlightMode

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

Declaration
public LineHighlightMode HighlightMode { get; set; }
Property Value
LineHighlightMode

Methods

GetTags(NormalizedSnapshotSpanCollection)

Gets a collection of TextHighlightTag tags.

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

Returns
System.Collections.Generic.IEnumerable<TagSpan<TextHighlightTag>>

Overrides
Telerik.WinForms.SyntaxEditor.Core.Tagging.TaggerBase<Telerik.WinForms.SyntaxEditor.Core.Tagging.TextHighlightTag>.GetTags(Telerik.WinForms.SyntaxEditor.Core.Text.NormalizedSnapshotSpanCollection)

HighlightLines(IEnumerable<Int32>)

Updates the highlighted lines.

Declaration
public void HighlightLines(IEnumerable<int> lines)
Parameters
System.Collections.Generic.IEnumerable<System.Int32> lines

The lines to highlight.

Extension Methods