Skip to main content

FieldOptions.HighlightMode Property

Gets or sets when the document fields should be highlighted.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

[DefaultValue(FieldsHighlightMode.Auto)]
public FieldsHighlightMode HighlightMode { get; set; }

Property Value

Type Default Description
FieldsHighlightMode Auto

A FieldsHighlightMode enumeration member specifying the condition.

Available values:

Name Description
Auto

Default highlight mode (equals to FieldsHighlightMode.Never)

Never

Document fields are not visually recognized.

Always

Document fields are always highlighted.

Property Paths

You can access this nested property as listed below:

Object Type Path to HighlightMode
RichEditControlOptionsBase
.Fields .HighlightMode

Remarks

To specify the highlight color, use the FieldOptions.HighlightColor property. Options for display of the document fields are available via the RichEditControlOptionsBase.Fields property of the RichEditControl’s and RichEditDocumentServer’s options.

The following code snippets (auto-collected from DevExpress Examples) contain references to the HighlightMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also