Accruent Meridian Enterprise 2020 VBScript API Reference

DocGenericEvent_OnProperties Event

Occurs when a user views or edits the property pages of a document or folder.

Syntax

DocGenericEvent_OnProperties(Command, Abort)
Parameters

Name

Description

Command

A long integer that represents one or more AS_PROP_CMD constants that indicate which button the user clicked. The constants are described in the following table.

Abort

Set to True to abort the operation.

Remarks

This event occurs in the Meridian client applications when Command includes the constants indicated in the following table.

AS_PROP_CMD
constants
Constant Action Meridian PowerWeb PowerUser

AS_PS_CMD_VIEW

The user started viewing the property page.

AS_PS_CMD_EDIT

The user clicked Edit to start property page (wizard) editing.

AS_PS_CMD_APPLY1

The user clicked Next to apply changes to the current page.

AS_PS_CMD_FINISH

The user clicked Finish to apply changes to the last page and stop property page (wizard) editing.

AS_PS_CMD_CANCEL

The user clicked Cancel to discard changes and stop property page (wizard) editing.

Note:
  1. This constant is represented in PowerUser only when the Finish button is clicked at the end of a wizard. In Meridian PowerWeb, it is included every time the Next button is clicked for a wizard page. Property values may not be set in Meridian PowerWeb if this constant is represented.
  • This event does not occur in Meridian PowerWeb when creating folders.

Use this event with much caution. In PowerUser, when Command includes AS_PS_CMD_VIEW, setting Abort to True will prevent display of all property pages. Attempting to set property values at that time can cause errors such as "The object is currently being edited by another session" and lost data.

We recommend that you not execute other actions, make modifications to the document content, invoke anything that takes a relatively long time, or invoke any user interface functions during this event. Such actions can have unexpected or unpredictable results.