DocumentVariableCollection Class

A collection of document variables.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

[ComVisible(true)]
public class DocumentVariableCollection

VB.NET

<ComVisible(True)>
Public Class DocumentVariableCollection

Related API Members

The following members return DocumentVariableCollection objects:

• Document.Variables

Remarks

Use the Document.Variables property to get access to the DocumentVariableCollection.

The DocumentVariableCollection holds variables as key-value pairs (the variable name is the key).

The DOCVARIABLE field can be used to insert a document variable value in the document. Handle one of the following events to adjust the content inserted in place of the field as required:

• RichEditDocumentServer.CalculateDocumentVariable
• Document.CalculateDocumentVariable
• RichEditControl.CalculateDocumentVariable (WinForms)
• RichEditControl.CalculateDocumentVariable (WPF)

Use the SubDocument.Fields property to access the DOCVARIABLE fields.

Inheritance

Object

DocumentVariableCollection