The References object represents the collection of Meridian references of a document. The References object is available to the current Document object.
The References object is accessed by the Document.GetReferences method.
References Object Properties
The References object provides the following properties, all of which are read-only. To affect some read-only properties requires user interaction or custom event procedures.
Count Property
The total number of references of the current Document object. Read-only.
Syntax
Count As Long
Exist Property
Returns True if the document specified by DocID is referenced by the current Documentobject.
Syntax
Exist(DocID) As Boolean
Target Property
Gets the referenced document specified by the collection index or DocID in Item. Read-only.
Syntax
Target(Item) As IASDocument5
References Object Methods
The References object methods affect the current Document object.
Add Method
Adds a reference by index or DocID to the current Document object.
Syntax
Add(DocID As String, [RefDisplayName As String])
| Name | Description |
|---|---|
|
DocID |
The DocID value of the document to reference. |
|
RefDisplayName |
The name to display for the reference as seen by users. |
Remarks
For events to occur for this method, the DocRefEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y (default).
Delete Method
Deletes a reference from the current Document object by References index number or DocID.
Syntax
Delete(Item)
| Name | Description |
|---|---|
|
Item |
The References index or DocID value of the reference to delete. |
Remarks
For events to occur for this method, the DocRefEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y (default).
Refresh Method
Refreshes the current References collection.
Syntax
Refresh
Parameters
This method accepts no parameters.
