The requested page is not available for the requested platform. You are viewing the content for Default platform.

CalculateDocumentVariableEventArgs Class

Provides data for an event that allows you to update the DOCVARIABLE field's result.

Declaration

export class CalculateDocumentVariableEventArgs extends EventArgs

Remarks

Use the OnCalculateDocumentVariable(String) property to assign a handler to the event.

Inheritance

EventArgs
CalculateDocumentVariableEventArgs

Properties

args Property

Provide access to arguments within the DOCVARIABLE field.

Declaration

args: string[]

Property Value

Type Description
string[]

An array containing DOCVARIABLE field arguments.

value Property

Specifies the result of the DOCVARIABLE field that fired the event.

Declaration

value: any

Property Value

Type Description
any

A string that is a field result.

variableName Property

Gets the name of the document variable to which the DOCVARIABLE field refers.

Declaration

variableName: string

Property Value

Type Description
string

The name of the document variable.

Remarks

The variableName property enables you to identify a document variable for which the event is fired.