officefileapi-devexpress-dot-xtrarichedit-dot-fieldoptions-51f4b5aa.md
Gets or sets when the document fields should be highlighted.
Namespace : DevExpress.XtraRichEdit
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
[DefaultValue(FieldsHighlightMode.Auto)]
public FieldsHighlightMode HighlightMode { get; set; }
<DefaultValue(FieldsHighlightMode.Auto)>
Public Property HighlightMode As FieldsHighlightMode
| 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.
|
You can access this nested property as listed below:
| Object Type | Path to HighlightMode |
|---|---|
| RichEditControlOptionsBase |
.Fields .HighlightMode
|
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 snippet (auto-collected from DevExpress Examples) contains a reference 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.
how-to-replace-document-fields-with-their-values/CS/Form1.cs#L17
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always;
richEditControl1.Options.Fields.HighlightColor = Color.Yellow;
how-to-replace-document-fields-with-their-values/VB/Form1.vb#L16
richEditControl1.LoadDocument("Template.rtf")
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always
richEditControl1.Options.Fields.HighlightColor = Color.Yellow
See Also