CalculateDocumentVariableEventArgs.Value Property

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

Namespace: DevExpress.XtraRichEdit

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

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

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

Use the Value property to specify the DOCVARIABLE field’s value. You can set this property to the Document or the RichEditDocumentServer object.

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#

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

e.Value = result;
e.Handled = true;

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

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

word-document-api-use-docvariable-fields/CS/WordProcessingFileAPI_CalcDocumentVariable/Program.cs#L49

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

word-document-api-insert-dynamic-content/CS/word-processing-dynamic-content/Program.cs#L32

e.KeepLastParagraph = true;
e.Value = GenerateRssFeed();
if (e.Value != null)

VB.NET

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

e.Value = result
e.Handled = True

how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L76

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

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

If(Equals(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.

word-document-api-insert-dynamic-content/VB/how-to-insert-dynamic-content/Module1.vb#L25

e.KeepLastParagraph = True
e.Value = GenerateRssFeed()
If e.Value IsNot Nothing Then