CalculateDocumentVariableEventHandler Delegate

A method that will handle the CalculateDocumentVariable event.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public delegate void CalculateDocumentVariableEventHandler(
    object sender,
    CalculateDocumentVariableEventArgs e
);

VB.NET

<ComVisible(True)>
Public Delegate Sub CalculateDocumentVariableEventHandler(
    sender As Object,
    e As CalculateDocumentVariableEventArgs
)

Parameters

Name	Type	Description
sender	Object	The event source. This parameter identifies the RichEditControl, which raised the event.
e	CalculateDocumentVariableEventArgs	A AutoCorrectEventArgs object which contains event data.

Remarks

When creating a CalculateDocumentVariableEventHandler delegate, you identify the method that will handle the corresponding event. To associate an event with your event handler, add a delegate instance to this event. The event handler is called whenever the event occurs unless you remove the delegate. For more information about event handler delegates, see Events and Delegates in MSDN.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalculateDocumentVariableEventHandler delegate.

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#L21

richEditControl1.Options.MailMerge.DataSource = new SampleData();
richEditControl2.Document.CalculateDocumentVariable += new CalculateDocumentVariableEventHandler(eventHandler_CalculateDocumentVariable);
this.richEdit = richEditControl1;