BeforeWizard event


	BlueCielo Meridian Enterprise 2012 Developer's Guide \| BlueCielo ECM Solutions

BeforeWizard event

This event occurs on events that initiate a wizard. Wizards are optional (depending on the settings in the Meridian Enterprise Configurator). This event always occurs just before a wizard is shown, or just before it would have been shown.

Syntax

Private Sub AMUIExtension_BeforeWizard(
          ByVal NewObject As Object,
          CalculateDisplayName As Boolean,
          CalculateLocation As Boolean,
          ShowPages As Boolean,
          Abort As Boolean)

Parameters
Name	Description
NewObject	The newly created object.
CalculateDisplayName	Set this argument to False if the extension does not implement the CalculateDisplayName event.
CalculateLocation	Set this argument to False if the extension does not implement the CalculateLocation event.
ShowPages	Set this argument to False if the wizard pages for this extension should not be shown.
Abort	Setting this argument to True will abort the invoked operation. The AfterInvoke event will not occur.

Remarks

The most common use of wizards is for newly created documents. But a wizard can also be shown for existing objects, for example, when a document’s type is changed.

Note When a document is created in the vault, its location is often determined by a Field-Path Relation or calculated by an interface extension. Therefore the parent folder is unknown during the BeforeWizard event.

By default the document will be created in the folder that was selected by the user. This folder is available from the m_Designer.GetParentFolder method. The AMDocument object.ParentFolder property will not be available for newly created documents. Bear in mind that the folder returned by m_Designer.GetParentFolder may not be the folder in which the new document is created.

Note Setting the ShowPages argument to False will cause the m_Designer.Visible property to return False. The Visible property of your wizard pages should also return False in this case.

For documents the equivalent VBScript event is the NewDocument script event. See the BlueCielo Meridian Enterprise VBScript API Reference for more information.

You may notice there is a BeforeWizardEx method defined in the interface designer. This method is not used.