Skip to main content
All docs
V25.1
  • TextEditCustomHighlightTextEventArgs.HighlightWords(String, Action<TextEdit.Block>, CompareOptions) Method

    Highlights or custom paints whole words.

    Namespace: DevExpress.XtraEditors

    Assembly: DevExpress.XtraEditors.v25.1.dll

    NuGet Package: DevExpress.Win.Navigation

    Declaration

    public void HighlightWords(
        string text,
        Action<TextEdit.Block> settings,
        CompareOptions options = CompareOptions.IgnoreCase
    )

    Parameters

    Name Type Description
    text String

    The text of target words.

    settings Action<TextEdit.Block>

    Allows you to specify display settings or a custom painter for 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 highlights or custom paints the found words as specified by the settings object. The settings parameter allows you to customize word display options:

    • Specify the background and foreground colors.
    • Add padding.
    • Supply a painter that will paint text. For instance, your painter can draw text using a custom font, or display an icon or smiley.

    The following characters are considered word separators:

    See Also