XRTextBox.CalculateDocumentVariable Event

Occurs during export and allows you to customize DOCVARIABLE fields added to the Textbox item content.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public event CalculateDocumentVariableEventHandler CalculateDocumentVariable

VB.NET

Public Event CalculateDocumentVariable As CalculateDocumentVariableEventHandler

Event Data

The CalculateDocumentVariable event's data class is CalculateDocumentVariableEventArgs. The following properties provide information specific to this event:

Property	Description
Arguments	Provides access to a collection of arguments within the DOCVARIABLE field.
FieldLocked	Gets or sets a locked attribute to the field for which the event occurs.
Handled	Gets or sets whether the default action is required.
KeepLastParagraph	Gets or sets whether the last paragraph of the inserted document is kept in the resulting document.
PreserveInsertedContentFormatting	Gets or sets whether to insert an additional hidden paragraph so that the inserted content is not formatted with the DOCVARIABLE field’s paragraph formatting.
Value	Gets or sets the value of the DOCVARIABLE field that fired the event.
VariableName	Gets the name of the document variable to which the DOCVARIABLE field refers.

Remarks

The code snippet below demonstrates how to handle the CalculateDocumentVariable event to add custom text to the Exporter DOCVARIABLE field’s value:

C#

using DevExpress.DashboardCommon;
using DevExpress.XtraReports.UI;
using System.Collections.Generic;
using System.Windows.Forms;
//...
private void DashboardDesigner_CustomExport(object sender, CustomExportEventArgs e){
    foreach (KeyValuePair<string, XRControl> xrControl in e.GetPrintableControls()){
        XRTextBox xrTextBox = xrControl.Value as XRTextBox;
        if (xrTextBox != null){
            xrTextBox.CalculateDocumentVariable += OnCalculateDocumentVariable;
        }
    }
}
private void OnCalculateDocumentVariable(object sender, DevExpress.XtraRichEdit.CalculateDocumentVariableEventArgs e){
    if(e.VariableName=="DataItem0")
        e.Value += " (Custom text for Exporter)";
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.XtraReports.UI
Imports System.Collections.Generic
Imports System.Windows.Forms
'...
Private Sub DashboardDesigner_CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs)
    For Each xrControl As KeyValuePair(Of String, XRControl) In e.GetPrintableControls()
        Dim xrTextBox As XRTextBox = TryCast(xrControl.Value, XRTextBox)
        If xrTextBox IsNot Nothing Then
            AddHandler xrTextBox.CalculateDocumentVariable, AddressOf OnCalculateDocumentVariable
        End If
    Next xrControl
End Sub
Private Sub OnCalculateDocumentVariable(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.CalculateDocumentVariableEventArgs)
    If e.VariableName="DataItem0" Then
        e.Value &= " (Custom text for Exporter)"
    End If
End Sub