Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TextEditCustomHighlightTextEventArgs.HighlightWords(String, Color, CompareOptions) Method

Highlights whole words using a custom foreground color.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

public void HighlightWords(
    string text,
    Color foreColor,
    CompareOptions options = CompareOptions.IgnoreCase
)

#Parameters

Name Type Description
text String

The text of target words.

foreColor Color

A custom foreground color used to paint the target words.

#Optional Parameters

Name Type Default Description
options CompareOptions IgnoreCase

An object that specifies text comparison settings used to locate target words.

#Remarks

The HighlightWords method locates all whole words that match the text parameter according to the options text comparison setting. The method then paints the found words with the foreColor color.

The following characters are considered word separators:

Use the HighlightRanges methods to highlight or custom paint all occurencies of a sub-string, even if they are part of words.

See Also