TextEditCustomHighlightTextEventArgs.HighlightWords(String, Color, Color, CompareOptions) Method

Highlights whole words using custom foreground and background colors.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v21.1.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

Public Sub HighlightWords(
    text As String,
    foreColor As Color,
    backColor As Color,
    options As CompareOptions = CompareOptions.IgnoreCase
)

Parameters

Name	Type	Description
text	String	The text of target words.
foreColor	Color	A custom foreground color to paint the target words.
backColor	Color	A custom background color to paint the target words.

Optional Parameters

Name	Type	Default	Description
options	CompareOptions	1	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 and backColor colors.

The following characters are considered word separators:

• Punctuation marks (see Char.IsSeparator)
• White space (see Char.IsWhiteSpace)
• Separator characters (see Char.IsSeparator)