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

WordTaggerBase

Class

Base tagger class for classification of words.

Definition

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

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

public abstract class WordTaggerBase : TaggerBase<ClassificationTag>, ITagger<ClassificationTag>

Inheritance: objectTaggerBase<ClassificationTag>WordTaggerBase

Derived Classes: JavaScriptTaggerSqlTaggerCSharpTaggerVisualBasicTagger

Implements: ITagger<ClassificationTag>

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

Constructors

WordTaggerBase(RadSyntaxEditor)

Initializes a new instance of the WordTaggerBase class.

protected WordTaggerBase(RadSyntaxEditor editor)

Parameters:editorRadSyntaxEditor

The editor.

Properties

EnableMultilineTags

bool

Gets or sets a value indicating whether multiline tags are collected by this tagger instance. The method RebuildMultilineTags() process all document and collects Multiline tags in the MultilineTags property.

public bool EnableMultilineTags { get; set; }

MultilineTags

IList<TagSpan<ClassificationTag>>

The list of multiline ClassificationTags wrapped in TagSpans.

protected IList<TagSpan<ClassificationTag>> MultilineTags { get; }

StringMatchingRegex

string

Gets or sets the regex pattern used to match strings in the documents which this tagger recognizes.

protected virtual string StringMatchingRegex { get; set; }

Methods

AddWord(string, ClassificationType)

Adds a new word-type pair in the dictionary.

public void AddWord(string word, ClassificationType classificationType)

Parameters:wordstringclassificationTypeClassificationType

GetCharType(char)

Defines the different char types which is the essence of splitting words. A word is considered sequence of equally typed chars. 1 - whitespace, 2 - punctuation or symbol, 0 - letters and all other characters.

protected virtual int GetCharType(char character)

Parameters:charactercharReturns:

int

GetTags(NormalizedSnapshotSpanCollection)

Gets the tags.

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

Parameters:spansNormalizedSnapshotSpanCollectionReturns:

IEnumerable<TagSpan<ClassificationTag>>

Overrides: TaggerBase<ClassificationTag>.GetTags(NormalizedSnapshotSpanCollection)

GetWordsToClassificationTypes()

Gets the words to classification types.

protected abstract Dictionary<string, ClassificationType> GetWordsToClassificationTypes()

Returns:

Dictionary<string, ClassificationType>

Dictionary<System.String, ClassificationType>.

InvalidateMultilineTags()

Clears all multiline tags and rebuilds them.

protected virtual void InvalidateMultilineTags()

OnWordSplit(int, string)

Called when a word is split during processing of a line string.

protected virtual void OnWordSplit(int wordCharType, string word)

Parameters:wordCharTypeintwordstring

RebuildMultilineTags()

Rebuilds the MultilineTags collection.

protected virtual void RebuildMultilineTags()

SplitIntoWords(string)

Splits the given string into collection of words.

protected virtual IList<string> SplitIntoWords(string value)

Parameters:valuestring

The given string to split.

Returns:

IList<string>

List of the words.

TryGetClassificationType(string, out ClassificationType)

Tries to get the classification type for the given string word.

protected virtual bool TryGetClassificationType(string word, out ClassificationType classificationType)

Parameters:wordstring

The string word.

classificationTypeClassificationType

The result classification type.

Returns:

bool

Returns true if classification type is found, otherwise - false.

TryRemoveWord(string)

Tries to removes a given word from the dictionary.

public bool TryRemoveWord(string word)

Parameters:wordstringReturns:

bool