Client Object

The Client object represents the current client application (for example, PowerUser).

Following are the predefined, read-only Client object arguments that are set by MS Outlook and IBM Lotus Notes application links when email messages are stored in a vault. You can use these arguments to obtain additional information that may be useful when working with particular events. The value of each argument is evident from the argument name.

AttachmentName
AttachmentsCount
BCC
BodyFormat
CC
ConversationIndex
ConversationTopic
CRC32
CreatingTime
EntryID
Importance
MAPIFolder
ReadReceiptRequested
ReceivedByName
ReceivedTime
Saved
SenderEmailAddress
SenderName
Sent
SentOn
Size
Subject
To
UnRead

For more information about arguments, see Object Arguments.

BuildNr Property

The version number of the AmEdmUI.dll client library file.

Syntax

BuildNr As String

Remarks

Returns the same number regardless of the active client application. This property can be used to detect outdated client software installations.

ClientID Property

A number that represents the active client applications for the current transaction. The number is the sum of one or more AS_CLIENTID constants.

Syntax

ClientID As Long

ClientProductCode Property

Number that represents the client product. Read-only.

Syntax

ClientProductCode As String

Confirmation Property

Set this property to True or False to control the display of confirmation prompts that appear to users for some commands. Action is specified as one of the AS_CONFIRM_ACTION constants that corresponds to the prompt that you want to enable or disable, respectively. The available constants can be found in the Constants branch of the Object Browser in the Meridian Enterprise Script Editor.

Syntax

Confirmation(Action) As Boolean

Remarks

In PowerWeb, client confirmation is supported for these actions:

AS_CONFIRM_COPYFPRSUBLEVELS — Defines what to do with FPR properties during project copy creation.
AS_CONFIRM_ALLOW_SKIPWIZARD_ALL — Partly supported for workflow transition wizards. Not supported for new document/folder wizards and auto command wizards.
AS_CONFIRM_APPLY_FOR_ALL — Partly supported for workflow transition wizards. Not supported for new document/folder wizards and auto command wizards.
AS_CONFIRM_COPY_FOLDER — Use the DocGenericEvent_SelectTarget event.
AS_CONFIRM_IMPORT_FOLDER — Use the DocGenericEvent_SelectTarget event.
AS_CONFIRM_PROJECT_FOLDER — Use the DocGenericEvent_SelectTarget event.

CurrentScope Property

Name of the current scope.

Syntax

CurrentScope As String

CurrentView Property

Name of the active navigation view. Read-only.

Syntax

CurrentView As String

Remarks

This property is not supported in PowerWeb.

ImportDetails Property

Long integer that represents one or more AS_IMPORT_DETAILS constants. This property is set only when the ImportType property contains a valid value. Read-only.

Syntax

ImportDetails As AS_IMPORT_DETAILS

ImportType Property

Long integer that represents one or more AS_IMPORTTYPE constants. Available only for new documents. Read-only.

Syntax

ImportType As AS_IMPORTTYPE

Type Property

The client application platform. Returns HTML for PowerWeb. Read-only.

Syntax

Type As String

Viewer Property

See Viewer Object. Read-only.

Syntax

Viewer As IASViewer

Client Object Methods

The Client object methods affect the current client application. The client application executes these methods only after the current operation (and all its event procedures) have finished. These commands may invoke new events.

The Client object methods are described below.

GoTo Method

Select the specified object. Makes the specified object the current object.

Syntax

GoTo(Document/Folder)

Parameters
Name	Description
Document/Folder	Document or Folder object to make the selected object.

Remarks

The method is available in PowerWeb with these limitations:

If the target document or folder is not visible in the current Scope, the Client.Goto statement is ignored.
If the target document or folder is not visible in the view, PowerWeb switches to the Explorer view.
In ActiveX mode, Client.Goto is ignored.

GoToView Method

Shows the specified view.

Syntax

GoToView(ViewName)

Parameters
Name	Description
ViewName	Name of the Navigation view to make the current view.

Remarks

Not available in PowerWeb.

Log Method

Sends a message to the VBScript debugging log.

Syntax

Log(Flags As AS_LOG_FLAGS, Message As String, [Source As String])

Parameters
Name	Description
Flags	Long integer that represents one or more of the AS_LOG_FLAGS constants. You define the meaning of each of the AS_LOG_FLAGS constants. They are only provided as a convenience for filtering the log and have no other effect than the icons shown for the log entries. Use AS_LF_DEBUG to limit logging to debug mode. Use AS_LF_MASK to combine constants.
Message	Text to send to the log.
Source	Optional name of the source of the message.

Remarks

Not available in PowerWeb. To configure and view the log, see Debugging VBScript.

NewMailMessage Method

Creates a new email message object.

Syntax

NewMailMessage() As IASMailMessage

Parameters

This method accepts no parameters.

Return Value

A new MailMessage object as described in MailMessage Object.

Remarks

Not available in PowerWeb.

OpenInApplication Method

Opens the specified document in the application that is registered in Windows for the document's file extension.

Syntax

OpenInApplication(Document)

Parameters
Name	Description
Document	An object that represents the document to open.

Remarks

Not available in PowerWeb.

Refresh Method

Refreshes the client application.

Syntax

Refresh(Flags As AS_REFRESHFLAG)

Parameters
Name	Description
Flags	Long integer that represents one or more of the AS_REFRESHFLAGS constants.

Remarks

Not available in PowerWeb.