ISWiSuiteAction Object (Advanced UI and Suite/Advanced UI)

InstallShield 2026 » Automation Interface » Advanced UI and Suite/Advanced UI

Project: This information applies to Suite/Advanced UI projects.

Edition:The Advanced UI project type is available in the Professional edition of InstallShield. The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

The ISWiSuiteAction object represents an action in the Suite/Advanced UI project.

To add or remove actions, call ISWiProject.AddSuiteAction or ISWiProject.DeleteAction. Schedule actions by calling ISWiSuiteEvent.AddSuiteAction Ref or ISWiSuiteEvent.DeleteSuiteActionRef.

Note that some ISWiSuiteAction properties are applicable to only certain action types.

Members

ISWiSuiteAction Object Members

Name

Type

Description

AbortCode

Read-Write String Property

Note:This property applies to .exe actions.

Gets or sets a comma-delimited list of the codes that the action could return when the installation should be aborted. Note that if the action cannot be launched or loaded, the installation is aborted.

This property is available if the value of the action’s WaitForExit property is True.

ActionName

Read-Only String Property

Gets or sets the name of the action.

Arguments

Read-Write String Property

Note:This property applies to .exe actions.

If appropriate, gets or sets the command-line parameters that should be used with the action. Separate multiple parameters with spaces.

CancelCode

Read-Write String Property

Note:This property applies to .exe actions.

Gets or sets a comma-delimited list of the codes that the action could return when the installation should be cancelled.

This property is available if the value of the action’s WaitForExit property is True.

Class

Read-Write String Property

Note:This property applies to managed-code and .NET Core actions.

Gets or sets the name of the class for the managed method that you want the selected action to call.

To learn more, see the following:

•

Working with a Managed-Code Action in a Suite/Advanced UI Installation.

•

Working with a .NET Core Action in a Suite/Advanced UI Installation.

DefaultResponse

Read-Write Integer Property

Note:This property applies to .exe actions.

Gets or sets a string that describes how you want the installation to respond if the code that the action returns is not specified for the IgnoreCode, AbortCode, RebootCode, or CancelCode properties. Available values are:

•

esadcIgnore (0)—The installation proceeds with the next part of the installation. This is the default option.

•

esadcAbort (1)—The installation is aborted.

•

esadcReboot (2)—The target system is restarted.

•

esadcCancel (3)—The installation is cancelled.

This property is available if the value of the action’s WaitForExit property is True.

FormatPropertyValue

Read-Write Boolean Property

Note:This property applies to actions that set a property.

Gets or sets the value of the Format Property Value setting in the Events view. This setting lets you indicate whether the value that you enter in the Property Value setting (or through the PropValue property in the automation interface) is a formatted expression that contains property names, environment variable references, or other special strings that you want to be resolved at run time. Available options are:

•

True—Replace the formatted expressions at run time.

•

False—Leave the property value as is at run time. The value that you are entering does not include formatted expressions.

To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

FunctionName

Read-Write String Property

Note:This property applies to DLL and InstallScript actions.

For a DLL action: Gets or sets the name of the function in the DLL that you would like to call.

For an InstallScript action: Gets or sets the InstallScript function that you want to call.

IgnoreCode

Read-Write String Property

Note:This property applies to .exe actions.

Gets or sets a comma-delimited list of the codes that the action could return when the installation should proceed with the next part of the installation.

This property is available if the value of the action’s WaitForExit property is True.

Method

Read-Write String Property

Note:This property applies to managed-code and .NET Core actions.

Gets or sets the public method that you want the selected action to call.

To learn more, see the following:

•

Working with a Managed-Code Action in a Suite/Advanced UI Installation.

•

Working with a .NET Core Action in a Suite/Advanced UI Installation.

PropName

Read-Write String Property

Note:This property applies to actions that set a property.

Gets or sets the property name.

PropValue

Read-Write String Property

Note:This property applies to actions that set a property.

Gets or sets the value of the property.

If you select True for the FormatPropertyValue property, the value that you enter can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

RebootCode

Read-Write String Property

Note:This property applies to .exe actions.

Gets or sets a comma-delimited list of the codes that the action could return when the target system should be restarted.

This property is available if the value of the action’s WaitForExit property is True.

RequireAdminPrivileges

Read-Only Boolean Property

Gets or sets the value of the Requires Administrative Privileges setting in the Events view. This setting indicates whether this action requires administrative privileges on systems that have Windows Vista or later or Windows Server 2008 or later.

To learn more, see Minimizing the Number of User Account Control Prompts During Advanced UI and Suite/Advanced UI Installations.

SourcePath

Read-Write String Property

Note:This property applies to PowerShell actions.

Gets or sets the source path to the PowerShell script (.ps1) that you want to use for your action.

If the file is not present on target systems at run time, and if none of the packages in your Suite/Advanced UI installation are going to install it, you can reference a file that is included in your project as a support file. At run time, the file is available on the target system only during your product’s installation process.

Instead of hard-coding a location, you can use a path variable that is defined in the Path Variables view. At build time, InstallShield replaces the path variable with the appropriate value.

TargetFile

Read-Write String Property

Note:This property applies to .exe, DLL, managed-code, and .NET Core actions.

Gets or sets the run-time path to the file that you want to use for your action.

Type

Read-Only Integer Property

Gets the type of action. Available value are:

•

esatDll (1)—Calls a function in a DLL file.

•

esatPowerShell (2)—Runs a PowerShell script to perform system configuration tasks.

•

esatExe (4)—Launches an executable file.

•

esatSetProperty (16)—Sets a Suite/Advanced UI property.

•

esatIScript (32)—Runs InstallScript code.

•

esatClr (64)—Calls a public method in a managed assembly.

•

esatCoreClr (128)—Calls a public method in a .NET Core managed assembly.

Verb

Read-Write String Property

Note:This property applies to .exe actions.

Gets or sets the verb that should be used with the selected action’s file.

If you leave this property blank, the verb that is the default one on the target system for this file is used. If the default verb is not available, the open verb is used. If neither verb is available, the first verb that is listed in the registry is used.

The use of the runas verb is not recommended. If the action requires administrative privileges, select True for the action’s RequireAdminPrivileges property. For more information, see Minimizing the Number of User Account Control Prompts During Advanced UI and Suite/Advanced UI Installations.

WaitForExit

Read-Write Boolean Property

Note:This property applies to .exe actions.

Gets or sets the value of the Wait for Exit setting in the Events view. This setting is where you indicate whether you want the installation to wait for the action to complete before proceeding with the next part of the installation. Available options are:

•

True—The installation waits for the action to complete before resuming. This is the default option.

•

False—The installation runs the action simultaneously as the next part of the installation proceeds.

If you select True for this setting, you can use the IgnoreCode, AbortCode, RebootCode, and CancelCode properties to specify the various codes that the action may return.

Window

Read-Write Integer Property

Note:This property applies to .exe actions.

Gets or sets the initial window state of the .exe action when it is launched. Available options are:

•

esawShow (0)—Display the window in its current size and position.

•

esawHide (1)—Hide the window.

•

esawMin (2)—Display the window as minimized.

•

esawMax (3)—Display the window as maximized.

•

esawNormal (4)—Display the window in its original size and position.

Applies To

•

ISWiProject