Skip to content

Overview of Components

Components are groups of related files defined within a package. Each component includes a name, optional description, a unique custom variable to control installation, and a list of associated files. Components allow you to organize files logically and let end users select which components to install.

If you don't define additional components, use the default "main" component to specify your package files.

Note: Every package must contain at least one component named "Main". It cannot be removed or renamed.

Components can be created, edited, or deleted through the component manager in the file manager window:

Component Properties

Highlight a component title in the list and press the Properties button (or double-click the icon) to edit its properties. The following tabs are available:

  • Global Properties
  • Component Variable
  • Selection Dialog

Global Properties

Exclude the entire component from the build

This ensures that all files within the specified component are excluded from the installation package. This means that none of the files assigned to this component will be compiled or included in the final package. This option is useful for creating different versions of the installer or excluding optional components based on specific build configurations.

Note

This option is especially useful in case of Directives.

Component Live Update (Synchronization)

You can link a component to a source folder, allowing automatic synchronization of its contents:

  • Live Update: Automatically adds new files and removes missing files from the component.
  • Refresh Options: Right-click the component and choose "Live update this component" to refresh manually.
  • Subfolder Inclusion: Enable recurrence to include files in subfolders.
  • Filename Mask for Inclusion/Exclusion: Specify masks to filter files. Example: *.exe|*.dll includes .exe and .dll files.

Note

Files are automatically added and removed only if the component is linked to a source folder. Otherwise, files are not modified by a live update operation.

Storing Path Information

Override global path settings for files in this component:

  • Default Settings: Recommended for most cases.
  • No Path Information: Ensures only filenames are stored (avoiding duplicate filenames).
  • Relative Paths: Store paths relative to a specified root folder.

Component Variable

Each component has a unique Boolean variable (VCOMP) set to 1 (true) for installation or 0 (false) to skip.

  • Default Installation: Enable this option to install the component by default unless the variable is modified.
  • Variable Management: Modify the component variable using custom actions or allow users to adjust it in the Component Selection dialog.

Selection Dialog Box

If you include a Component Selection dialog, configure these options:

  • Component Title: A short name displayed near the check box.
  • Component Description: Additional details about the component.
  • User Selection: Allow users to enable/disable the component.
  • Required Component: Ensure the component is always installed by disabling its checkbox.

Setting Custom Destination Folders

To assign a custom destination folder for a component's files, select the files and specify the folder through File Properties.