CalculateDocumentVariableEventArgs.Value Property

Gets or sets the value of the DOCVARIABLE field that fired the event.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

public object Value { get; set; }

VB.NET

Public Property Value As Object

Property Value

Type	Description
Object	An object that is inserted into a document in place of the DOCVARIABLE field.

Remarks

Apart from the common object types such as string, datetime and numeric types, which could be converted to strings for display, you can pass complex objects that are able to provide document content. Actually, you can specify the Document or the RichEditDocumentServer for the Value property.

This functionality is quite useful for implementing complex reports, such as master-detail reporting. See this approach in action in our demo application - module Master-Detail Reporting.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value 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#

how-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L77

if ((location.Trim() == String.Empty) || (location.Contains("<"))) {
    e.Value = " ";
    e.Handled = true;

dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282/CS/MainWindow.xaml.cs#L76

if ((location.Trim() == String.Empty) || (location.Contains("<"))) {
    e.Value = " ";
    e.Handled = true;

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

// Return the document to insert.
e.Value = richServerMaster;
// Required to use e.Value. Otherwise it will be ignored.

how-to-create-nested-fields-programmatically-e4004/CS/Form1.cs#L47

private void richEditControl1_CalculateDocumentVariable(object sender, CalculateDocumentVariableEventArgs e) {
    e.Value = e.VariableName + "'s value";

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

if (e.VariableName == "dvField") {
    e.Value = "Test";
    e.Handled = true;

VB.NET

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L77

If (location.Trim() = String.Empty) OrElse (location.Contains("<")) Then
    e.Value = " "
    e.Handled = True

word-document-api-use-docvariable-fields/VB/WordProcessingFileAPI_CalcDocumentVariable/Program.vb#L28

If(Equals(location.Trim(), String.Empty)) OrElse location.Contains("<") Then
    e.Value = " "
    e.Handled = True

dxrichedit-for-wpf-how-to-use-document-variable-docvariable-fields-e3282/VB/MainWindow.xaml.vb#L76

If (location.Trim() = String.Empty) OrElse (location.Contains("<")) Then
    e.Value = " "
    e.Handled = True

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

' Return the document to insert.
e.Value = richServerMaster
' Required to use e.Value. Otherwise it will be ignored.

how-to-create-nested-fields-programmatically-e4004/VB/Form1.vb#L49

Private Sub richEditControl1_CalculateDocumentVariable(ByVal sender As Object, ByVal e As CalculateDocumentVariableEventArgs) Handles richEditControl1.CalculateDocumentVariable
    e.Value = e.VariableName & "'s value"