IdxRichEditDocumentVariableCollection Interface
Exposes a collection of document variables.
Declaration
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.
- Add
- Creates a new document variable and adds it to the collection.
- Clear
- Clears the document variable collection.
- Count | GetCount
- Return the number of document variables in the collection.
- GetVariableNames
- Returns an array populated with all stored document variable names.
- GetVariableValue
- Returns 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.
- Remove
- Removes an individual document variable from the collection.
Direct IdxRichEditDocumentVariableCollection Interface Reference
The IdxRichEditDocument.Variables property references the IdxRichEditDocumentVariable interface.
Inheritance
IInterface
IdxRichEditDocumentVariableCollection
See Also