References Object

The References object represents the collection of Meridian references of a document. The References object is available to the current Document object.

Note:

The References object is accessed by the Document.GetReferences method.

ClosedReferences 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.

ClosedCount Property

The total number of references of the current Document object. Read-only.

Syntax

Count As Long

ClosedExist Property

Returns True if the document specified by DocID is referenced by the current Documentobject.

Syntax

Exist(DocID) As Boolean

ClosedProperties Property

Returns an array of properties for the reference.

Syntax

Properties As Variant()

Return Value

The array contains the following information.

Note:

The values Target/Source and Source/Target in the Object column indicate that the object depends on the direction of the reference.

Return Values of Properties

Index Value

Object

Property

Notes

0

  Internal Properties

This is an internal property that is not relevant to end-users.

1

  Internal Properties

This is an internal property that is not relevant to end-users.

2

DocRef InternalName  

3

DocRef DisplayName  

4

DocRefType ID  

5

Target/Source Document ID

Target/Source in the Object column indicates that the object depends on the direction of the reference.

6 Target/Source Document Display Name

Target/Source in the Object column indicates that the object depends on the direction of the reference.

7 Target/Source Reference Description

Target/Source in the Object column indicates that the object depends on the direction of the reference.

8 Source/Target Document ID

Source/Target in the Object column indicates that the object depends on the direction of the reference.

9 Source/Target Document Display Name

Source/Target in the Object column indicates that the object depends on the direction of the reference.

10 Source/Target Reference Description

Source/Target in the Object column indicates that the object depends on the direction of the reference.

11   DRT

This is an internal property that is not relevant to end-users.

12

 

DRT_OPTION_FLAGS

This is an internal property that is not relevant to end-users.

13

Reference

InternalName

The internal name of the reference.

Example

Copy
If Not Document Is Nothing Then
    'Add your code for document objects
    Dim props
    props = Document.GetReferences().Properties
    Dim aprop
    aprop = props(0)
    WinMsgBox aprop(13)          
ElseIf Not Folder Is Nothing Then
    'Add your code for folder objects
End If   

ClosedTarget Property

Gets the referenced document specified by the collection index or DocID in Item. Read-only.

Syntax

Target(Item) As IASDocument5

ClosedReferences Object Methods

The References object methods affect the current Document object.

ClosedAdd Method

Adds a reference by index or DocID to the current Document object.

Syntax

Add(DocID As String, [RefDisplayName As String])
Parameters
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).

ClosedDelete Method

Deletes a reference from the current Document object by References index number or DocID.

Syntax

Delete(Item)
Parameters
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).

ClosedRefresh Method

Refreshes the current References collection.

Syntax

Refresh

Parameters

This method accepts no parameters.

2022 R2