Open topic with navigation

Feature Object

InstallShield 2015 » Object Expressions for Advanced UI and Suite/Advanced UI Projects

To create an object expression that checks target systems for information about a feature in an Advanced UI or Suite/Advanced UI installation, use the Feature object. The Feature object has support for properties such as DisplayName, ActionState, and InstalledState.

Syntax

[@Feature(FeatureName).ActionState]

[@Feature(FeatureName).AllowSelectionChange]

[@Feature(FeatureName).Cost]

[@Feature(FeatureName).Description]

[@Feature(FeatureName).DisplayName]

[@Feature(FeatureName).InstalledState]

[@Feature(FeatureName).Visible]

Parameters

One parameter is available for the Feature object.

Parameters for the Feature Object

Parameter

Description

FeatureName

Specify the name of the feature.

Properties

The following properties are available for the Feature object.

Properties for the Feature Object

Property

Description

ActionState

Retrieves the currently set action state of the feature. Valid values are:

• 0—No action will be taken for the feature.
• 1—The feature will be installed.
• 2—The feature will be removed.

AllowSelectionChange

Retrieves a Boolean value that indicates whether end users should be allowed to select or deselect the feature on the InstallationFeatures wizard page. Valid values are:

• true—End users should be able to select or deselect the feature through the wizard interface. This is the default option.
• false—End users should not be able to select or deselect the feature through the wizard interface. If this feature is visible on the InstallationFeatures wizard page, it appears in a read-only state (either selected or deselected, based on other factors, such as the feature’s condition).

Cost

Retrieves how much space (in bytes) the feature requires on the target system if this value was specified in the Features view.

Description

Retrieves the localized description of the feature.

DisplayName

Retrieves the localized display name of the feature.

InstalledState

Retrieves the installed state of the feature as determined by the package detection states of the packages in the feature. Valid values are:

• 0—The feature is not currently installed.
• 3—The feature is installed.

Visible

Retrieves a Boolean value that indicates whether the feature should be visible on the InstallationFeatures wizard page during installation.

Examples

The following examples demonstrate use of the Feature object in object expressions.

Sample Feature Object Expressions

Expression

Description

[@Feature(FeatureABC).ActionState]

Determine whether the Advanced UI or Suite/Advanced UI is installing the FeatureABC feature.

[@Feature(FeatureABC).Cost]

Determine how much space (in bytes) the feature requires.

See Also

Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time

Writing Object Expressions in Advanced UI and Suite/Advanced UI Projects to Search Target Systems

InstallShield 2015 Help Library

June 2015

 Copyright Information | Contact Us