ISWiProject Object (Advanced UI and Suite/Advanced UI)

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

Project • This information applies to the following project types:

•

Advanced UI

•

Suite/Advanced UI

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.

ISWiProject contains the interface for opening, closing, and saving an Advanced UI or Suite/Advanced UI project (.issuite) file. When InstallShield is installed on your system, you can instantiate a copy of ISWiProject with the following VB and VBScript syntax:

Set m_ISWiProject = CreateObject("ISWiAutoSuiteAutomation Interface Version.ISWiProject")

To open an installation project, call the OpenProject method, as follows:

' Build path to the .ism file

strFile = "C:\InstallShield 2019 Projects\Test.issuite"

m_ISWiProject.OpenProject strFile

Important • If you are using the automation interface on a 64-bit machine, you may need to load the automation interface through a 32-bit executable file. Otherwise, you may encounter an error when you instantiate a copy of ISWiProject, or any other object. For more information, see Using the Automation Interface on a 64-Bit System.

Members

The following members of the ISWIProject object are available in the automation interface. Note that some methods, properties, and collections are available only for a particular project type.

ISWiProject Object Members

Name

Type

Description

ActiveLanguage

Read-Write String Property

Gets or sets the default language of the project. Specify a single language as a language identifier; for example:

project.ActiveLanguage = "1033";

AddExitCondition

Method

Adds an exit error message that you want the Advanced UI or Suite/Advanced UI installation to display under various conditions before ending the installation.

AddLanguage

Method

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Adds a language to the project.

AddPathVariable

Method

Adds a path variable to the project.

AddProperty

Method

Adds an Advanced UI or Suite/Advanced UI property with a specified name to the project

AddSetupFile

Method

Adds a support file with the specified name to the project.

AddSuiteAction

Method

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Adds an action to the project.

AddSuiteFeature

Method

Adds a feature to the project or as a subfeature of an existing feature.

AddSuitePackage

Method

Adds a package to the project along with the specified target file and options for adding additional files.

AddSuiteRelease

Method

Adds a release to the project.

AddSuiteTransaction

Method

Adds a Windows Installer transaction to the project.

Once your project contains a transaction, you can add .msi and .msp packages to the transaction.

ArpComments

Read-Write String Property

Gets or sets comments about your product. This information is displayed for your product’s entry in Programs and Features.

ArpDisableChange

Read-Write Boolean Property

Gets or sets the value of the Disable Change Button setting in the General Information view. This setting is where you specify whether you want to disable the Change button for your product’s entry in Programs and Features. The Change button enables end users to change installation options after the product has been installed. End users can remove or add features as needed.

ArpDisableRegistration

Read-Write Boolean Property

Inhibits or allows registration of the product in Programs and Features. If registration is disabled, the other Arp properties are ignored. Available values are:

•

False—Your Advanced UI or Suite/Advanced UI product’s entry is displayed on the target system in Programs and Features. This is the default value.

•

True—Your Advanced UI or Suite/Advanced UI product’s entry is not displayed on the target system in Programs and Features. The end user cannot use Programs and Features to remove the product, perform maintenance, or view support information. If you select this option, the other Arp properties are irrelevant.

ArpDisableRemove

Read-Write Boolean Property

Gets or sets the value of the Disable Remove Button setting in the General Information view. This setting is where you specify whether you want to disable the Remove button for your product’s entry in Programs and Features. The Remove button enables end users to remove the product by clicking one button, which runs your uninstaller with a reduced user interface.

If the end user clicks the Remove button to remove your product, actions in the User Interface sequence of the project are executed.

ArpHelpContact

Read-Write String Property

Gets or sets the name of the person or department that end users should contact for technical support.

On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Programs and Features.

ArpHelpTelPhone

Read-Write String Property

Gets or sets the technical support phone number for your product.

On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Programs and Features.

ArpHelpUrl

Read-Write String Property

Gets or sets the URL that you would like end users to visit for technical support information for your product. This URL is displayed for your product’s entry in Programs and Features.

ArpIcon

Read-Write String Property

Gets or sets the path on your development system to the .ico, .exe or .dll file that contains the icon resource that you want to be used for your product’s entry in Programs and Features.

If you want to use the icon in a file that is present on target systems (for example, in a file that is installed by one of the packages in the Advanced UI or Suite/Advanced UI installation), you can use a directory property as part of the path for the icon file. If you leave this property empty, InstallShield uses the icon that is specified in the Setup.exe Icon File setting on the Setup.exe tab in the Releases view.

ArpIconIndex

Read-Write Integer Property

If the icon file that you specify contains more than one icon resource, you can use the ArpIconIndex property to specify the index.

•

A nonnegative integer refers to the order of the icon resources in the executable file. For example, 0 refers to the first icon in the file, 1 refers to the second icon, and 2 refers to the third icon.

•

Use a negative number to refer to a specific resource ID. For example, the icon index -12 refers to the icon with a resource ID of 12.

ArpProductUrl

Read-Write String Property

Gets or sets a general URL for your company or product—for example, http://www.mycompany.com.

On some versions of Windows, the publisher name on the Support Info dialog box is a hyperlink to this URL. The Support Info dialog box is displayed when an end user clicks the support information hyperlink for your product’s entry in Programs and Features.

ArpPublisher

Read-Write String Property

Gets or sets the name of the company that created the product. This information is displayed for your product’s entry in Programs and Features.

ArpReadMe

Read-Write String Property

Gets or sets a valid URL for a Readme file or Customer Support page for your product.

On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Programs and Features.

ArpUpdateUrl

Read-Write String Property

Gets or sets a URL where end users can get information about product updates or download the latest version.

On some versions of Windows, this information is displayed on the Support Info dialog box for your product’s entry in Programs and Features.

CloseProject

Method

Closes an Advanced UI or Suite/Advanced UI project.

CreateProject

Method

Creates a new InstallShield project file (.issuite) for an Advanced UI or Suite/Advanced UI project.

DeleteExitCondition

Method

Removes an exit error message from the project.

DeleteLanguage

Method

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Removes a language from the project.

DeletePathVariable

Method

Removes a path variable from the project.

DeleteProperty

Method

Removes an Advanced UI or Suite/Advanced UI property from the project.

DeleteSetupFile

Method

Removes a support file from the project.

DeleteSuiteAction

Method

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Removes an action from the project.

DeleteSuiteFeature

Method

Removes a feature from the project.

DeleteSuitePackage

Method

Removes a package or a Windows Installer transaction from the project.

DeleteSuiteRelease

Method

Removes a release from the project.

ForceUpgrade

Method

Upgrades the project from an earlier version of InstallShield to the current version.

GenerateGUID

Method

Generates a new, unique GUID that is returned as a string.

OpenProject

Method

Opens an Advanced UI or Suite/Advanced UI project so that you can modify it through the automation interface

ISWiLanguages

Collection

Contains all of the languages in the current project.

ISWiPathVariables

Collection

Contains all of the Advanced UI or Suite/Advanced UI path variables in the current project.

ISWiProperties

Collection

Contains all of the Advanced UI or Suite/Advanced UI properties in the current project.

ISWiSetupFiles

Collection

Contains all of the support files in the current project.

ISWiSuiteActions

Collection

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Contains all of the Suite/Advanced UI actions that are included in a project.

ISWiSuiteEvent

Method

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Accesses a specific event in the project.

ISWiSuiteEvents

Collection

Project • This is available in Suite/Advanced UI projects.

Edition • The Suite/Advanced UI project type is available in the Premier edition of InstallShield.

Contains all of the events that are in a project.

ISWiSuiteFeatures

Collection

Contains every feature (as an ISWiSuiteFeature object) in your project.

When ISWiSuiteFeatures is a member of ISWiProject, it contains all of the root-level features in the project. To retrieve a collection of subfeatures, access the Features property of the ISWiSuiteFeature object. The result is an ISWiSuiteFeatures collection that contains the immediate subfeatures of the current root-level feature. Repeat for further levels of subfeatures.

ISWiSuiteExitConditions

Collection

Contains all of the exit conditions in your project.

ISWiSuitePackages

Collection

Contains every package (as an ISWiSuitePackage object) and every Windows Installer transaction (also as an ISWiSuitePackage object) in your project.

ISWiSuiteReleases

Collection

Contains all of the releases in your Advanced UI or Suite/Advanced UI project.

ProductName

Read-Write String Property

Gets or sets the name of the product. For information on how the product name is used, see Specifying a Product Name.

ProjectType

Read-only Integer Property

Gets the project type. The valid value is:

•

eptSuite (16)—Advanced UI or Suite/Advanced UI project

ProductVersion

Read-Write String Property

Gets or sets the version number for your product. The version must contain only numbers. It is typically in the format aaa.bbb.ccccc or aaa.bbb.ccccc.ddddd, where aaa represents the major version number, bbb represents the minor version number, ccccc represents the build number, and ddddd represents the revision number. The maximum value for the aaa and bbb portions is 255. The maximum value for ccccc and ddddd is 65,535.

Note that although you can include the fourth field (ddddd), the installation does not use this part of the product version to distinguish between different product versions. To learn more, see Specifying the Product Version.

SaveProject

Method

Saves the Advanced UI or Suite/Advanced UI project.

SuiteGuid

Read-Write String Property

Gets or sets a GUID that uniquely identifies the Advanced UI or Suite/Advanced UI installation. To have generate a different GUID, call GenerateGUID.

Since this code uniquely identifies your Advanced UI or Suite/Advanced UI installation, changing the Suite GUID after you have already distributed your release is not recommended.

ISWiProject Object (Advanced UI and Suite/Advanced UI)

InstallShield 2019 Help Library

April 2019