Skip to main content

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

CalculateDocumentVariableEvent Class

An event that occurs when a DOCVARIABLE field is updated.

#Declaration

TypeScript
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.

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

@(Html.DevExpress().RichEdit("richEdit")
 .OnCalculateDocumentVariable("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.

#Inheritance

See Also