CalculateDocumentVariableEventArgs.Handled Property

Gets or sets whether the default action is required.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true if no default action is necessary; otherwise, false.

Remarks

Set the Handled property to true, to prevent the default actions associated with the this event. In this case, only the event handler code is executed.

Related GitHub Examples

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

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

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

    // Required to use e.Value. Otherwise it will be ignored.
    e.Handled = true;
}

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

e.Value = " ";
e.Handled = true;
return;

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

e.Value = " ";
e.Handled = true;
return;

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

e.Value = " ";
e.Handled = true;
return;

VB.NET

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

    e.Value = result
    e.Handled = True
End If

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

    ' Required to use e.Value. Otherwise it will be ignored.
    e.Handled = True
End If

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

e.Value = " "
e.Handled = True
Return

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

e.Value = " "
e.Handled = True
Return

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

e.Value = " "
e.Handled = True
Return