DXRichEditFieldOptions.ClearUnhandledDocVariableField Property

Gets or sets whether the DOCVARIABLE field value is cleared when it cannot be calculated. This is a dependency property.

Namespace: DevExpress.Xpf.RichEdit

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

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public bool ClearUnhandledDocVariableField { get; set; }

VB.NET

Public Property ClearUnhandledDocVariableField As Boolean

Property Value

Type	Description
Boolean	true, to clear the value if it is not calculated; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ClearUnhandledDocVariableField
RichEditControl	.FieldOptions .ClearUnhandledDocVariableField

Remarks

The ClearUnhandledDocVariableField property allows you to set the default behavior in the situation when the DOCVARIABLE field value cannot be calculated. It can happen in the following situations:

• A key-value pair for the DOCVARIABLE field is not found in the Document.Variables dictionary
• The RichEditControl.CalculateDocumentVariable event is not handled