Fullscreen Image

Scope Object

The Scope object represents a named feature set that is configured for the current vault. A scope simplifies and limits users' access to only the configurable features that the users need.

For more information about scopes, see Scopes.

Scope Object Properties

The Scope object provides the following properties.

ClosedDisplayName Property

The Display Name property of the scope.

Syntax

Vault.Scope(<ScopeInternalName>).Displayname As String

Remarks

This property affects scopes defined in Meridian Enterprise Configurator, not scopes defined by the VaultEvent_ChangeScope event.

ClosedName Property

Returns the name of the current object. Depending on the object type, this property returns the display name of the object or it returns the internal name and may be read-only.

Syntax

Name As String

Remarks

If the current object is a Package, it must be in the Open status to set the value.

If the current object is a User, this property is the short name of the user as stored in the user's Meridian account information and is read-only. This property can be used to specify the recipient's email address and either an empty string or no value set in the Address property. If an email address is specified in Name, it must be surrounded with carets (<>). When used with Microsoft Outlook, the Name property may contain the user's full name or last name and Outlook will attempt to resolve the name to the email address in the default address book.

Meridian user names can be shown in different formats determined by the UserNameFormatserver registry setting.

ClosedDocumentTypes Property

Returns a semicolon-delimited string containing a list of the document types that have been configured for the selected scope. Read-only.

Syntax

Vault.Scope(Client.CurrentScope).DocumentTypes As String

Remarks

Calling this method results in an error if the user has nothing selected.

ClosedRootFolder Property

The name of the root folder of the scope. Read-only.

Syntax

Vault.Scope(<ScopeInternalName>).RootFolder As String

Remarks

To obtain a folder object that is the root folder of the scope, use the expression:

Vault.RootFolder.GetSubFolder(Vault.Scope(<ScopeInternalName>).RootFolder)

The Scope object provides the following methods.

2024