ASPxRichEdit.CalculateDocumentVariable Event

Fires when the DOCVARIABLE field field is updated.

Namespace: DevExpress.Web.ASPxRichEdit

Assembly: DevExpress.Web.ASPxRichEdit.v24.2.dll

Declaration

C#

public event CalculateDocumentVariableEventHandler CalculateDocumentVariable

VB.NET

Public Event CalculateDocumentVariable As CalculateDocumentVariableEventHandler

Event Data

The CalculateDocumentVariable event's data class is CalculateDocumentVariableEventArgs. The following properties provide information specific to this event:

Property	Description
Arguments	Provides access to a collection of arguments within the DOCVARIABLE field.
FieldLocked	Gets or sets a locked attribute to the field for which the event occurs.
Handled	Gets or sets whether the default action is required.
KeepLastParagraph	Gets or sets whether the last paragraph of the inserted document is kept in the resulting document.
PreserveInsertedContentFormatting	Gets or sets whether to insert an additional hidden paragraph so that the inserted content is not formatted with the DOCVARIABLE field’s paragraph formatting.
Value	Gets or sets the value of the DOCVARIABLE field that fired the event.
VariableName	Gets the name of the document variable to which the DOCVARIABLE field refers.

Remarks

The CalculateDocumentVariable event is fired when the DOCVARIABLE field value is calculated.

You can handle this event to analyze DOCVARIABLE field switches and arguments, and provide custom content to insert into this field. The content can be of any supported type, and even as complex as another generated (mail merged) document.

To learn more, see the Document Variables Support demo.