InstallBuilder User Guide 24

name

newcomponent

string

Name of the Component. This property does not allow variables.

description

New Component

string

Description of the Component

canBeEdited

1

0, 1

Whether or not the component can be edited in the component selection page. This property does not allow variables.

detailedDescription

text

A detailed description of the component

downloadable

0

0, 1

Whether component should be downloadable. This property does not allow variables.

requiredSize

0

string

Required disk space in the target system. If 0, then it will automatically be calculated based on the size of the packed files

selected

1

0, 1

Whether or not the component is selected. This property does not allow variables.

shouldPackRuleEvaluationLogic

and

and, or

Packing rules evaluation logic

show

1

0, 1

Whether or not the component is visible in the component selection page. This property does not allow variables.

url

string

URL to specific component, overrides project’s component URL

componentSelectionValidationActionList

Actions executed after the component page, to check that the selected components are a valid combination

<action>

customLanguageFileList

Language files for customizing the installer translation

<language>

desktopShortcutList

Shortcuts to be placed in the Desktop

<shortcut>, <applicationShortcut>, <linkShortcut>, <fileShortcut>

folderList

Destination folders for the installer files

<folder>

initializationActionList

Actions executed when the installer has started

<action>

installationAbortedActionList

Actions executed if the installation is aborted

<action>

onDownloadErrorActionList

Actions executed if a component could not be downloaded and user chose to ignore its installation

<action>

parameterList

Pages that are displayed to the user through the GUI and text interfaces

<parameter>

platformOptionsList

Platform-specific project options

<platformOptions>

postBuildActionList

Actions executed after the installer has been built

<action>

postInstallationActionList

Actions executed after the installation process has taken place, but before the uninstaller is created and the final page is displayed

<action>

postUninstallationActionList

Actions executed after the uninstallation process has finished

<action>

postUninstallerCreationActionList

Actions executed after the uninstaller has been created and before the installation complete page is displayed.

<action>

preBuildActionList

Actions executed before generating the installer file

<action>

preInitializationActionList

Actions executed directly after loading the project information

<action>

preInstallationActionList

Actions executed before the first page of the installer is displayed

<action>

preUninstallationActionList

Actions executed before the uninstallation process takes place

<action>

quickLaunchShortcutList

Shortcuts to be placed in the Windows Quick Launch toolbar

<quickLaunchLinkShortcut>, <quickLaunchFileShortcut>, <quickLaunchShortcut>

readyToInstallActionList

Actions executed right before the file copying step starts

<action>

shouldPackRuleList

Conditions that are evaluated at build time to decide if the component will be packed.

<rule>

startMenuShortcutList

Link to applications, documents or URL for the Windows Start menu

<startMenuLinkShortcut>, <startMenuFileShortcut>, <startMenuShortcut>, <startMenuFolder>

description

New Folder

string

Folder description

destination

${installdir}/newfolder

string

Path of new folder

name

newfolder

string

Folder name. This property does not allow variables.

platforms

all

all, linux, linux-x64, linux-arm64, linux-arm32, linux-ia64, windows, windows-x64, osx, solaris-sparc, solaris-intel, linux-ppc, linux-s390, linux-s390x, freebsd, freebsd4, freebsd6, freebsd6-x64, freebsd7, freebsd7-x64, openbsd3, hpux, aix, irix-n32

Platforms in which this folder will be installed

ruleEvaluationLogic

and

and, or

Rule evaluation logic

shouldPackRuleEvaluationLogic

and

and, or

Packing rules evaluation logic

actionList

List of actions

<action>

distributionFileList

Files to Install

<distributionFile>, <distributionDirectory>

ruleList

Conditions that are evaluated and depending on the result, the action is executed, the page associated with the parameter shown or the folder installed

<rule>

shortcutList

Shortcuts for applications, documents or URLs for Windows

<shortcut>

shouldPackRuleList

Conditions that are evaluated at build time to decide if the component will be packed.

<rule>

allowWildcards

0

0, 1

Whether or not to use wildcards

excludeFiles

string

Patterns to exclude files

filterEvaluationLogic

and

and, or

Filter evaluation logic

includeFiles

*

string

Patterns to include files

origin

string

File to pack

allowWildcards

0

0, 1

Whether or not to use wildcards

excludeFiles

string

Patterns to exclude files

filterEvaluationLogic

and

and, or

Filter evaluation logic

includeFiles

*

string

Patterns to include files

origin

string

Directory to pack

logic

matches

matches, does_not_match

Whether or not the pattern must match to pass the filter.

pattern

string

Pattern to match against the path of the file

patternType

glob

glob, regexp

Whether to use glob or regular expressions matching