Scripting: CreateEventWizard

CreateEventWizard

Introduced

v7.5

Description

Creates an instance of an event wizard you can use to generate self-installing event plug-ins. The resulting wizard is a CustomProperty nested under the SDK wizard model which itself resides under the scene root.

Scripting Syntax

oReturn = CreateEventWizard( [DestinationDir] );

Return Value

Newly created event wizard as a CustomProperty object.

Parameters

Parameter	Type	Description
DestinationDir	String	The destination folder for the plug-in to generate. Default Value: If no destination folder is specified, the wizard property will be created in the user path.

Examples

JScript Example

/*
        This example demonstrates how to create an event wizard using 
        the CreateEventWizard command and then generate a very simple 
        custom event using the new wizard.
*/
var eventwiz = CreateEventWizard();
eventwiz.PluginName = "XYZEventPlugin";
eventwiz.FileName = eventwiz.PluginName.Value;
eventwiz.ScriptLanguage = "JScript";
eventwiz.siOnKeyUp = true;
eventwiz.siOnKeyUpName = "XYZOnKeyUpEvent";
// Generates the XYZOnKeyUpEvent implementation and plug-in
GenerateEventPlugin(eventwiz);
var ev = Application.EventInfos("XYZOnKeyUpEvent");
Application.LogMessage(ev.Name);
// Expected results:
// INFO : XYZOnKeyUpEvent