CalculateDocumentVariableEventArgs.VariableName Property

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

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public string VariableName { get; }

VB.NET

Public ReadOnly Property VariableName As String

Property Value

Type	Description
String	A string that is the name of the document variable in the DOCVARIABLE field.

Remarks

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the VariableName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-richedit-create-a-master-detail-report/CS/RichEditMasterDetailMailMerge/Form1.cs#L76

//Check whether the event is raised to the required field:
if (e.VariableName == "Categories")
{

word-document-api-create-master-detail-report/CS/MasterDetailExample/MergeProcessor.cs#L70

{
    if (e.VariableName == "Supplier") {
        // Create a text engine to process a document after the mail merge.

wpf-richedit-use-docvariable-fields/CS/MainWindow.xaml.cs#L73

Console.WriteLine(e.VariableName + " " + location);

how-to-replace-document-fields-with-their-values/CS/Form1.cs#L28

private void richEditControl1_CalculateDocumentVariable(object sender, DevExpress.XtraRichEdit.CalculateDocumentVariableEventArgs e) {
    if (e.VariableName == "dvField") {
        e.Value = "Test";

wpf-richedit-embed-a-live-chart-into-a-document/CS/RichEdit_InsertChart/MainWindow.xaml.cs#L32

{
    if (e.VariableName == "CHART") {
        ChartImage chart = new ChartImage(e.Arguments[0].Value.ToString());

VB.NET

winforms-richedit-create-a-master-detail-report/VB/RichEditMasterDetailMailMerge/Form1.vb#L71

'Check whether the event is raised to the required field:
If e.VariableName = "Categories" Then
    'Provide the data source for the next document part:

word-document-api-create-master-detail-report/VB/MasterDetailExample/MergeProcessor.vb#L65

Private Sub resultRichEdit_CalculateDocumentVariable(ByVal sender As Object, ByVal e As CalculateDocumentVariableEventArgs)
    If Equals(e.VariableName, "Supplier") Then
        ' Create a text engine to process a document after the mail merge.

wpf-richedit-use-docvariable-fields/VB/MainWindow.xaml.vb#L71

Dim location As String = e.Arguments(0).Value.ToString()
Console.WriteLine(e.VariableName & " " & location)
If(Equals(location.Trim(), String.Empty)) OrElse location.Contains("<") Then

how-to-replace-document-fields-with-their-values/VB/Form1.vb#L25

Private Sub richEditControl1_CalculateDocumentVariable(ByVal sender As Object, ByVal e As CalculateDocumentVariableEventArgs)
    If Equals(e.VariableName, "dvField") Then
        e.Value = "Test"

wpf-richedit-embed-a-live-chart-into-a-document/VB/RichEdit_InsertChart/MainWindow.xaml.vb#L30

Private Sub richEditControl1_CalculateDocumentVariable(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.CalculateDocumentVariableEventArgs)
    If e.VariableName = "CHART" Then
        Dim chart As New ChartImage(e.Arguments(0).Value.ToString())