TextEditCustomHighlightTextEventArgs.HighlightRanges(String, Color, CompareOptions) Method

Highlights all text blocks that have the specified content using a custom foreground color.

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

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

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

Parameters

Name	Type	Description
text	String

A string that identifies target text blocks to be highlighted or custom painted.

| | foreColor | Color |

A custom foreground color used to paint text blocks.

Optional Parameters

Name	Type	Default	Description
options	CompareOptions	IgnoreCase

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

Remarks

The HighlightRanges method locates all text blocks that contain the string specified by the text parameter, and then paints the text blocks with the foreColor color.

Use the HighlightWords methods to highlight or custom paint whole words.