A newer version of this page is available. Switch to the current version.

FieldOptions.HighlightMode Property

Gets or sets when the document fields should be highlighted.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v18.2.Core.dll

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:

Library Object Type Path to HighlightMode
WinForms Controls SnapControlOptions
.Fields.HighlightMode
RichEditControlOptions
.Fields.HighlightMode
WPF Controls RichEditControlOptions
.Fields.HighlightMode
Office File API 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.

See Also