DocumentVariableCollection.GetVariableValue(String, ArgumentCollection) Method

Calculates the value of the specified document variable.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public virtual object GetVariableValue(
    string variableName,
    ArgumentCollection arguments
)

VB.NET

Public Overridable Function GetVariableValue(
    variableName As String,
    arguments As ArgumentCollection
) As Object

Parameters

Name	Type	Description
variableName	String	A string that is the document variable name.
arguments	ArgumentCollection	An ArgumentCollection object that holds arguments used to calculate the document variable value.

Returns

Type	Description
Object	An object associated with the document variable or calculated in the corresponding event.

Remarks

This method fires the CalculateDocumentVariable event. If the CalculateDocumentVariableEventArgs.Handled is set to true in the event’s handler, the GetVariableValue method returns the CalculateDocumentVariableEventArgs.Value. Otherwise, it returns the value associated with the specified name in the DocumentVariableCollection.