Back to Devexpress

IdxRichEditDocumentVariableCollection Interface

vcl-dxrichedit-dot-nativeapi-4436fb46.md

latest2.6 KB
Original Source

IdxRichEditDocumentVariableCollection Interface

Exposes a collection of document variables.

Declaration

delphi
IdxRichEditDocumentVariableCollection = interface(IInterface)

Remarks

A document variable is a placeholder field defined using the DOCVARIABLE keyword in a document.

Main API Members

The list below outlines key members of the IdxRichEditDocumentVariableCollection interface. These members allow you to manage document variables.

AddCreates a new document variable and adds it to the collection.ClearClears the document variable collection.Count | GetCountReturn the number of document variables in the collection.GetVariableNamesReturns an array populated with all stored document variable names.GetVariableValueReturns a value for a specified document variable name.Items | GetItem

Provide access to individual document variables (by name).

You can use the Count property to obtain the number of document variables accessible through the Items property.

RemoveRemoves an individual document variable from the collection.

Direct IdxRichEditDocumentVariableCollection Interface Reference

The IdxRichEditDocument.Variables property references the IdxRichEditDocumentVariable interface.

Inheritance

IInterface IdxRichEditDocumentVariableCollection

See Also

IdxRichEditFieldCollection Interface

IdxRichEditDocumentVariableCollection Members

dxRichEdit.NativeApi Unit