Argument.Value Property

Gets the value of an argument in the DOCVARIABLE field.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public string Value { get; }

VB.NET

Public ReadOnly Property Value As String

Property Value

Type	Description
String	A string, specifying the argument in the DOCVARIABLE field.

Remarks

To get access to the ArgumentCollection containing DOCVARIABLE arguments, handle the Document.CalculateDocumentVariable event, and use the CalculateDocumentVariableEventArgs.Arguments property.

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#

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

{
    int currentSupplierID = GetID(e.Arguments[0].Value);
    if (currentSupplierID == -1)

winforms-richedit-master-detail-mail-merge-essentials/CS/Form1.cs#L33

if (Int32.TryParse(e.Arguments[0].Value, out categoryId)) {
    richEditProductTemplate.Options.MailMerge.DataSource = NorthwindDataProvider.GetProductsByCategoryId(categoryId);

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/CS/Form1.cs#L49

if (Int32.TryParse(e.Arguments[0].Value, out detailId)) {
    RichEditDocumentServer server = new RichEditDocumentServer();

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

{
    int productId = GetID(e.Arguments[0].Value);
    if (productId == -1)

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.cs#L67

    return;
string name = e.Arguments[0].Value;
var customProperty = ((DevExpress.Xpf.RichEdit.RichEditControl)sender).Document.CustomProperties[name];

VB.NET

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

Private Sub richServerMaster_CalculateDocumentVariable(ByVal sender As Object, ByVal e As CalculateDocumentVariableEventArgs)
    Dim currentSupplierID As Integer = GetID(e.Arguments(0).Value)
    If currentSupplierID = -1 Then Return

winforms-richedit-master-detail-mail-merge-essentials/VB/Form1.vb#L29

Dim categoryId As Integer = -1
If Integer.TryParse(e.Arguments(0).Value, categoryId) Then
    richEditProductTemplate.Options.MailMerge.DataSource = GetProductsByCategoryId(categoryId)

winforms-richedit-use-calculatedocumentvariable-event-to-insert-formatted-content/VB/Form1.vb#L37

Dim detailId As Integer = -1
If Integer.TryParse(e.Arguments(0).Value, detailId) Then
    Dim server As RichEditDocumentServer = New RichEditDocumentServer()

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

Private Sub detail_CalculateDocumentVariable(ByVal sender As Object, ByVal e As CalculateDocumentVariableEventArgs)
    Dim productId As Integer = GetID(e.Arguments(0).Value)
    If productId = -1 Then

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.vb#L62

End If
Dim name As String = e.Arguments(0).Value
Dim customProperty = DirectCast(sender, DevExpress.Xpf.RichEdit.RichEditControl).Document.CustomProperties(name)