Class
TextSearchHighlightTagger

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

Definition

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

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

cs-api-definition
public class TextSearchHighlightTagger : TaggerBase<TextHighlightTag>, ITagger<TextHighlightTag>

Inheritance: objectTaggerBase<TextHighlightTag>TextSearchHighlightTagger

Implements: ITagger<TextHighlightTag>

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

Constructors

TextSearchHighlightTagger(ITextDocumentEditor, ITextFormatDefinitionKey)

Initializes a new instance of the TextSearchHighlightTagger class.

Declaration

cs-api-definition
public TextSearchHighlightTagger(ITextDocumentEditor editor, ITextFormatDefinitionKey formatDefinitionKey)

Parameters

editor

ITextDocumentEditor

formatDefinitionKey

ITextFormatDefinitionKey

Fields

SearchFormatDefinition

The search format definition.

Declaration

cs-api-definition
public static readonly ITextFormatDefinitionKey SearchFormatDefinition

Field Value

ITextFormatDefinitionKey

SelectedWordFormatDefinition

The selected word format definition.

Declaration

cs-api-definition
public static readonly ITextFormatDefinitionKey SelectedWordFormatDefinition

Field Value

ITextFormatDefinitionKey

Properties

Comparison

Gets or sets the search comparison type.

Declaration

cs-api-definition
public StringComparison Comparison { get; set; }

Property Value

StringComparison

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)

UpdateSearchWord(string)

Updates the search word.

Declaration

cs-api-definition
public void UpdateSearchWord(string newSearchWord)

Parameters

newSearchWord

string

The search word.