CalculateDocumentVariableEvent Class

An event that occurs when a DOCVARIABLE field is updated.

Declaration

export class CalculateDocumentVariableEvent extends RichEditEvent<CalculateDocumentVariableEventArgs>

Remarks

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

.NET Core Server Settings
Client Settings
Runtime Settings

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

cshtml

@(Html.DevExpress().RichEdit("richEdit")
 .OnCalculateDocumentVariable("function(s,e) {
   if (e.variableName == 'sectionIndex')
       e.value = (s.document.sections.find(e.fieldInterval.start).index + 1).toString();
 }")
 // ...

Use the calculateDocumentVariable property to specify the event handler.

javascript

const options = DevExpress.RichEdit.createOptions();
options.events.calculateDocumentVariable = function(s,e) {
  if (e.variableName == 'sectionIndex')
      e.value = (s.document.sections.find(e.fieldInterval.start).index + 1).toString();
};

The calculateDocumentVariable 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.calculateDocumentVariable.addHandler(function(s, e) {
  if (e.variableName == 'sectionIndex')
      e.value = (s.document.sections.find(e.fieldInterval.start).index + 1).toString();
});

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.

Inherited Members

addHandler(handler)

clearHandlers

isEmpty

removeHandler(handler)

Inheritance

Event<TSource, TEventArgs> RichEditEvent<TEventArgs> CalculateDocumentVariableEvent