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

DocumentVariableCollection.GetVariableValue(String, ArgumentCollection) Method

Calculates the value of the specified document variable.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

#Declaration

public virtual object GetVariableValue(
    string variableName,
    ArgumentCollection arguments
)

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

See Also