Documentation

Class TextSearchHighlightTagger

Class TextSearchHighlightTagger which prepares collection of TextHighlightTags for all occurrences of a given search word.

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

Constructors

TextSearchHighlightTagger(ITextDocumentEditor, ITextFormatDefinitionKey)

Initializes a new instance of the TextSearchHighlightTagger class.

Declaration
public TextSearchHighlightTagger(ITextDocumentEditor editor, ITextFormatDefinitionKey formatDefinitionKey)
Parameters
ITextDocumentEditor editor

ITextFormatDefinitionKey formatDefinitionKey

Fields

SearchFormatDefinition

The search format definition.

Declaration
public static readonly ITextFormatDefinitionKey SearchFormatDefinition
Field Value
ITextFormatDefinitionKey

SelectedWordFormatDefinition

The selected word format definition.

Declaration
public static readonly ITextFormatDefinitionKey SelectedWordFormatDefinition
Field Value
ITextFormatDefinitionKey

Properties

Comparison

Gets or sets the search comparison type.

Declaration
public StringComparison Comparison { get; set; }
Property Value
System.StringComparison

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)

UpdateSearchWord(String)

Updates the search word.

Declaration
public void UpdateSearchWord(string newSearchWord)
Parameters
System.String newSearchWord

The search word.

Extension Methods