CalculateDocumentVariableAsyncEvent Class

An event that allows you to update the results of all DOCVARIABLE fields in the document.

Declaration

export class CalculateDocumentVariableAsyncEvent extends RichEditEvent<CalculateDocumentVariableAsyncEventArgs>

Remarks

You can define the CalculateDocumentVariableAsync event handler either at the server side, at the client side, or at runtime.

.NET Core Server Settings
Client Settings
Runtime Settings

Use the OnCalculateDocumentVariableAsync(String) method to specify the event handler.

cshtml

@(Html.DevExpress().RichEdit("richEdit")
 .OnCalculateDocumentVariableAsync("function(s,e){
   e.data.forEach(function(data) {
     data.callback('ResultOf' + data.variableName);
   })
 }")
 ...

Use the calculateDocumentVariableAsync property to specify the event handler.

javascript

const options = DevExpress.RichEdit.createOptions();
options.events.calculateDocumentVariableAsync = function(s,e) {
    e.data.forEach(function(data) {
      data.callback('ResultOf' + data.variableName);
    })
  };

The calculateDocumentVariableAsync property provides access to the addHandler(handler), removeHandler(handler), and clearHandlers methods that allow you to dynamically add and remove event handlers.

javascript

richEdit.events.calculateDocumentVariableAsync.addHandler(function(s, e) {
    e.data.forEach(function(data) {
      data.callback('ResultOf' + data.variableName);
    })
  });

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

Note

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

Inherited Members

addHandler(handler)

clearHandlers

isEmpty

removeHandler(handler)

Inheritance

Event<TSource, TEventArgs> RichEditEvent<TEventArgs> CalculateDocumentVariableAsyncEvent