Skip to main content
JS

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RichEditBuilder.OnCalculateDocumentVariable(String) Method

Assigns an event handler to the CalculateDocumentVariable event.

Namespace: DevExpress.AspNetCore.RichEdit

Assembly: DevExpress.AspNetCore.RichEdit.v24.2.dll

NuGet Package: DevExpress.AspNetCore.RichEdit

#Declaration

C#
public RichEditBuilder OnCalculateDocumentVariable(
    string callback
)

#Parameters

Name Type Description
callback String

The name of the JavaScript function or the JavaScript function code used to handle the event.

#Returns

Type Description
RichEditBuilder

The builder for the Rich Text Editor.

#Remarks

The CalculateDocumentVariable event occurs when a DOCVARIABLE field is updated. Handle this event to analyze DOCVARIABLE field switches and arguments, and provide custom content to insert into this field.

The DOCVARIABLE field has the following structure: { DOCVARIABLE “variable name” “argument1” “argument 2”… }

The event handler receives an argument of the CalculateDocumentVariableEventArgs type. The argument’s properties provide information specific to this event.

Note

When the CalculateDocumentVariableAsyncEvent event handler is specified, the CalculateDocumentVariable event does not fire.

See Also