CreateFilterWizard

Introduced

v7.5

Description

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

Scripting Syntax

oReturn = CreateFilterWizard( [DestinationDir] );

Return Value

Newly created filter 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 a filter wizard using 

	the CreateFilterWizard command and then generate a very simple 

	custom filter using the new wizard.

*/

var filterwiz = CreateFilterWizard();

filterwiz.PluginName = "XYZFilter";

filterwiz.FileName = "XYZFilterPlugin";

filterwiz.ScriptLanguage = "JScript";

filterwiz.FilterName = "XYZFilter";

filterwiz.FilterType = siFilterProperty;

// Generates the XYZFilter implementation and plug-in

GenerateFilterPlugin(filterwiz);

var f = Application.Filters("XYZFilter");

Application.LogMessage(f.Name);

// Expected results:

// INFO : XYZFilter

See Also

GenerateFilterPlugin Filter Wizard help CreateCommandWizard CreatePropertyWizard CreateEventWizard CreateICENodeWizard CreateOperatorWizard