ISWiFolder Object

InstallShield 2015 » Automation Interface

Project: This information applies to the following project types:

Basic MSI
DIM
InstallScript
InstallScript MSI
InstallScript Object
Merge Module

ISWiFolder represents a program folder in a component’s Shortcuts explorer in the InstallShield user interface. You can retrieve a folder by specifying an item in the ISWiFolders collection.

Many folder attributes are available in the automation interface through this object’s methods and properties. Refer to the following table to learn which methods, properties, and collections are available for your project type.

Members

ISWiFolder Object Members

Name

Type

Description

AddShortcut

Method

Adds a shortcut object to the current folder object.

AddSubFolder

Method

Creates another program folder under the current one.

DeleteShortcut

Method

Deletes the specified shortcut from the current folder object.

DeleteSubFolder

Method

Deletes the specified subfolder from the current one.

Description

Read-Write Property

Contains any descriptive text you have entered for the folder.

DisplayName

Read-Write Property

Retrieves or sets the name displayed for a folder.

ISWiShortcuts

Collection

Contains every shortcut under the current program folder.

Name

Read-Write Property

Retrieves the key name of the folder. This is the name that is displayed in the Shortcuts view in the InstallShield user interface. It is not the same as the DisplayName property.

SharedFolder

Read-Write Property

This Boolean property retrieves or sets the Shared property of the folder, which specifies whether the folder is always removed from the system (False) or is removed only if it has no subfolders or files that were not created by the setup (True).

SubFolders

Collection

Contains an ISWiFolders collection of each program folder directly under the current folder as laid out in the Shortcuts explorer. See ISWiFolders Collection for an example of using this property to retrieve a subfolder.

Note: This property does not apply to InstallScript projects.

Applies To

ISWiComponent