ISWiSuiteFeature Object (Advanced UI and Suite/Advanced UI)

InstallShield 2018 » 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.

The ISWiSuiteFeature object represents a root-level feature or a subfeature in an Advanced UI or Suite/Advanced UI project. You can retrieve a feature by specifying an item in the ISWiSuiteFeatures collection.

Members

ISWiSuiteFeature Object Members

Name

Type

Description

AddCondition

Method

Adds a condition to a feature without a condition.

AddSuiteSubFeature

Method

Adds a subfeature to an existing feature.

AllowSelectionChange

Read-Write Boolean Property

Gets or sets the value of the Allow UI Selection Change setting for the feature. This setting indicates whether end users should be allowed to select or deselect the feature on the InstallationFeatures wizard page.

AttachPackage

Method

Associates a package in the project with a feature.

Condition

Read-only Object Property

This property accesses the ISWiSuiteCondition object.

Gets the feature’s condition, if one is associated with the feature.

Cost

Read-Write Property

Gets or sets how much space (in bytes) that the feature requires on the target system.

DeleteCondition

Method

Removes a condition from a feature.

DeleteSubSuiteFeature

Method

Removes a subfeature from a feature.

Description

Read-Write String Property

Gets or sets the description for this feature.

DisplayName

Read-Write String Property

Gets or sets the name of the feature.

FollowParentState

Read-Write Boolean Property

This property is available for subfeatures; it is not available for root-level features.

Gets or sets the value of the Follow Parent State setting for the subfeature. This setting indicates whether you want the subfeature’s state to be determined by its parent feature. Available values are:

• True—The selected subfeature will be installed whenever its parent feature is installed.
• False—If the selected subfeature's parent feature is installed, the selected subfeature can be either installed or not installed. This is the default option. Note that if the selected subfeature's parent feature is not installed, the selected subfeature cannot be installed.

This setting is especially useful if you want the subfeature to be hidden on the InstallationFeatures wizard page, but its parent feature is not hidden.

ISWiSuiteFeatures

Collection

Contains all of the subfeatures that are assigned to a feature.

ISWiSuitePackages

Collection

Contains all of the packages that are associated with a feature.

Name

Read-Write String Property

Gets or sets the name of the feature in the collection.

ReleaseFlags

Read-Write String Property

Gets or sets the release flags that are associated with this feature. Separate multiple flags with a comma.

You can specify which release flags you want to use to filter the project’s features in the ReleaseFlags property of ISWiRelease.

RemovePackage

Method

Removes a package from a feature.

Visible

Read-Write Boolean Property

Gets or sets the feature’s Visible setting, which specifies whether the feature will be visible on the InstallationFeatures wizard page during installation.

Example

The following VBScript lines display information about a feature. Since feature can include subfeatures, the script is implemented recursively.

Sub WriteFeature(indent, f)

    out.WriteLine indent & f.DisplayName & " (" & f.Name & ")"

    out.WriteLine indent & " Release Flags:" & f.ReleaseFlags

    If f.Visible Then out.WriteLine indent & " Visible"

    If Not f.AllowSelectionChange Then out.WriteLine indent & " Disabled"

    If f.FollowParentState Then out.WriteLine indent & " Follow Parent"

    If Not f.Condition Is Nothing Then

        out.WriteLine indent & " Condition:"

        WriteCondition indent & " ", f.Condition

    End If

    out.WriteLine indent & " Packages:"

    For Each p in f.Packages

        out.WriteLine indent & " " & IDS(p.DisplayName)

    Next

    out.WriteLine indent & " Child Features:"

    For Each sf in f.SubFeatures

        WriteFeature indent & " ", (sf)

    Next

End Sub

Applies To

• ISWiProject
• ISWiSuiteFeature

InstallShield 2018 Help Library

January 2018

 Copyright Information | Flexera

Open topic with navigation