Type: object

Definition of dialogs and controls used to compose MSI installer user interfaces.

root version
Type: string

The schema version used for this JSON/YAML document.

root dialog
Type: object

The dialog defined by this document that is presented to the user during installation.

root dialog name
Type: string

The dialog name. Must be unique within the package.

root dialog title
Type: string

The window title for this dialog. The default value is '[ProductName] Setup'.

root dialog hCentering
Type: integer

The relative horizontal centering position of the dialog on the screen. The default value is 50.

root dialog vCentering
Type: integer

The relative vertical centering position of the dialog on the screen. The default value is 50.

root dialog width
Type: integer

The dialog window width in pixels. The default value is 370.

root dialog height
Type: integer

The dialog window height in pixels. The default value is 270.

root dialog firstControl
Type: string

The control that receives focus when the dialog is opened.

root dialog defaultControl
Type: string

The control that is activated when the Return key is pressed.

root dialog cancelControl
Type: string

The control that is activated when the ESC key is pressed.

root dialog attributes
Type: array of enum (of string)

Dialog attributes represented as flags.

 No Additional Items

Each item of this array must be:

root dialog attributes attributes items
Type: enum (of string)

Must be one of:

  • "Visible"
  • "Modal"
  • "Minimize"
  • "SysModal"
  • "KeepModeless"
  • "TrackDiskSpace"
  • "UseCustomPalette"
  • "RTLRO"
  • "RightAligned"
  • "LeftScroll"
  • "BiDi"
  • "Error"

root dialog properties
Type: array of object
No Additional Items

Each item of this array must be:

root dialog properties properties items
Type: object

root dialog properties properties items name
Type: string

The property name.

root dialog properties properties items persistence
Type: enum (of string)

If specified, an attempt is made to read the property value during setup initialization.

Must be one of:

  • "None"
  • "Registry"
  • "IniFile"

root controls
Type: array

The list of controls added to this dialog.

 No Additional Items

Each item of this array must be:

root controls controls items

root controls controls items anyOf Bitmap
Type: object

root controls controls items anyOf item 0 allOf BaseControl
Type: object

root controls controls items anyOf item 0 allOf item 0 name
Type: string

The name of the control. It must be unique within the dialog.

root controls controls items anyOf item 0 allOf item 0 type
Type: enum (of string)

Must be one of:

  • "Bitmap"
  • "CheckBox"
  • "Edit"
  • "Icon"
  • "Line"
  • "ListBox"
  • "PushButton"
  • "RadioButtonGroup"
  • "Text"
  • "DirectoryCombo"
  • "DirectoryList"
  • "ProgressBar"
  • "VolumeCostList"
  • "PathEdit"
  • "ScrollableText"

root controls controls items anyOf item 0 allOf item 0 x
Type: integer

The horizontal position of the control in pixels.

root controls controls items anyOf item 0 allOf item 0 y
Type: integer

The vertical position of the control in pixels.

root controls controls items anyOf item 0 allOf item 0 width
Type: integer

The width of the control in pixels.

root controls controls items anyOf item 0 allOf item 0 height
Type: integer

The height of the control in pixels.

root controls controls items anyOf item 0 allOf item 0 property
Type: string

The property associated with the control's value.

root controls controls items anyOf item 0 allOf item 0 text
Type: string

root controls controls items anyOf item 0 allOf item 0 conditions
Type: array of object
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 0 allOf item 0 conditions conditions items
Type: object

root controls controls items anyOf item 0 allOf item 0 conditions conditions items action
Type: enum (of string)

The action to perform.

Must be one of:

  • "Default"
  • "Disable"
  • "Enable"
  • "Show"
  • "Hide"

root controls controls items anyOf item 0 allOf item 0 conditions conditions items condition
Type: string

The condition for the action. For more information, see <a href="https://learn.microsoft.com/en-us/windows/win32/msi/conditional-statement-syntax">documentation</a> for valid conditions.
root controls controls items anyOf item 0 allOf item 1
Type: object

root controls controls items anyOf item 0 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "Bitmap"

root controls controls items anyOf item 0 allOf item 1 text
Type: string

The name of a bitmap asset included in the package.
root controls controls items anyOf CheckBox
Type: object

root controls controls items anyOf item 1 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 1 allOf EventControl
Type: object

root controls controls items anyOf item 1 allOf item 1 events
Type: array of object

The events associated with the control. Events are processed in the order they are listed. For more information, see <a href="https://learn.microsoft.com/en-us/windows/win32/msi/controlevent-table">documentation</a> for valid events.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 1 allOf item 1 events events items
Type: object

root controls controls items anyOf item 1 allOf item 1 events events items event
Type: enum (of string)

The event to be handled.

Must be one of:

  • "CheckTargetPath"
  • "DirectoryListNew"
  • "DirectoryListOpen"
  • "DirectoryListUp"
  • "DoAction"
  • "EnableRollback"
  • "EndDialog"
  • "MsiPrint"
  • "NewDialog"
  • "RMShutdownAndRestart"
  • "Reinstall"
  • "ReinstallMode"
  • "Remove"
  • "Reset"
  • "SetTargetPath"
  • "ScheduleReboot"
  • "SpawnDialog"
  • "SpawnWaitDialog"

root controls controls items anyOf item 1 allOf item 1 events events items argument
Type: string

The argument supplied to the event.

root controls controls items anyOf item 1 allOf item 1 events events items condition
Type: string

The condition for the event. The default value is '1' (always execute). For more information, see https://learn.microsoft.com/en-us/windows/win32/msi/conditional-statement-syntax
root controls controls items anyOf item 1 allOf item 2
Type: object

root controls controls items anyOf item 1 allOf item 2 type
Type: enum (of string)

Must be one of:

  • "CheckBox"

root controls controls items anyOf item 1 allOf item 2 checkedValue
Type: string

The property value when checked. The default value is '1'.

root controls controls items anyOf item 1 allOf item 2 attributes
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 1 allOf item 2 attributes attributes items
Type: enum (of string)

Must be one of:

  • "Visible"
  • "Sunken"
  • "Stretched"
  • "FixedSize"
  • "Enabled"
  • "Indirect"
  • "IntegerControl"
  • "RTLRO"
  • "RightAligned"
  • "PushLike"
root controls controls items anyOf Edit
Type: object

root controls controls items anyOf item 2 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 2 allOf item 1
Type: object

root controls controls items anyOf item 2 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "Edit"

root controls controls items anyOf item 2 allOf item 1 attributes
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 2 allOf item 1 attributes attributes items
Type: enum (of string)

Must be one of:

  • "Visible"
  • "Enabled"
  • "Sunken"
  • "Integer"
  • "BiDi"
  • "RTLRO"
  • "RightAligned"
  • "LeftScroll"
  • "Multiline"
  • "Password"
root controls controls items anyOf Icon
Type: object

root controls controls items anyOf item 3 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 3 allOf item 1
Type: object

root controls controls items anyOf item 3 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "Icon"

root controls controls items anyOf item 3 allOf item 1 attributes
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 3 allOf item 1 attributes attributes items
Type: enum (of string)

Must be one of:

  • "Visible"
  • "Sunken"
  • "Stretched"
  • "FixedSize"
  • "IconSize16"
  • "IconSize32"
  • "IconSize48"
root controls controls items anyOf Line
Type: object
root controls controls items anyOf ListBox
Type: object
root controls controls items anyOf PushButton
Type: object

root controls controls items anyOf item 6 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 6 allOf EventControl
Type: object
Same definition as controls_items_anyOf_i1_allOf_i1
root controls controls items anyOf item 6 allOf item 2
Type: object

root controls controls items anyOf item 6 allOf item 2 type
Type: enum (of string)

Must be one of:

  • "PushButton"

root controls controls items anyOf item 6 allOf item 2 width
Type: integer

The width of the control in pixels. The default value is 56.

root controls controls items anyOf item 6 allOf item 2 height
Type: integer

The height of the control in pixels. The default value is 17.

root controls controls items anyOf item 6 allOf item 2 attributes
Type: array of enum (of string)
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 6 allOf item 2 attributes attributes items
Type: enum (of string)

Must be one of:

  • "Sunken"
  • "Visible"
  • "Enabled"
  • "RTLRO"
  • "Bitmap"
  • "Icon"
  • "Stretched"
  • "FixedSize"
  • "FirstImage"
  • "IconSize16"
  • "IconSize32"
  • "IconSize48"
  • "ElevationShield"

root controls controls items anyOf item 6 allOf item 2 eventMappings
Type: array of object

Lists the attribute to be changed when the event is published by another control or the Windows Installer.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 6 allOf item 2 eventMappings eventMappings items
Type: object

root controls controls items anyOf item 6 allOf item 2 eventMappings eventMappings items event
Type: string

Name of the event to subscribe to. For a complete list of events, see https://learn.microsoft.com/en-us/windows/win32/msi/controlevent-overview

root controls controls items anyOf item 6 allOf item 2 eventMappings eventMappings items attribute
Type: string

Attribute to be updated when the event is published.
root controls controls items anyOf RadioButtonGroup
Type: object

root controls controls items anyOf item 7 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 7 allOf item 1
Type: object

root controls controls items anyOf item 7 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "RadioButtonGroup"

root controls controls items anyOf item 7 allOf item 1 items
Type: array of object
No Additional Items

Each item of this array must be:

root controls controls items anyOf item 7 allOf item 1 items items items
Type: object

root controls controls items anyOf item 7 allOf item 1 items items items text
Type: string

The user-visible text describing the option.

root controls controls items anyOf item 7 allOf item 1 items items items value
Type: string

The value assigned to the associated property when this option is selected.

root controls controls items anyOf item 7 allOf item 1 items items items x
Type: integer

The horizontal position of the control in pixels.

root controls controls items anyOf item 7 allOf item 1 items items items y
Type: integer

The vertical position of the control in pixels.

root controls controls items anyOf Text
Type: object

root controls controls items anyOf item 8 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 8 allOf item 1
Type: object

root controls controls items anyOf item 8 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "Text"

root controls controls items anyOf item 8 allOf item 1 attributes
Type: array of enum (of string)

Text control attributes. The default values are 'Visible', 'Enabled', 'NoPrefix', and 'Transparent'.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 8 allOf item 1 attributes attributes items
Type: enum (of string)

Must be one of:

  • "Sunken"
  • "Visible"
  • "Enabled"
  • "IntegerControl"
  • "RTLRO"
  • "RightAligned"
  • "FormatSize"
  • "NoPrefix"
  • "NoWrap"
  • "Transparent"
  • "UsersLanguage"

root controls controls items anyOf item 8 allOf item 1 eventMappings
Type: array of object

Specifies the attributes that are updated when an event is published by another control or by Windows Installer.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 8 allOf item 1 eventMappings eventMappings items
Type: object

root controls controls items anyOf item 8 allOf item 1 eventMappings eventMappings items event
Type: string

Name of the event to subscribe to. For a complete list of events, see https://learn.microsoft.com/en-us/windows/win32/msi/controlevent-overview

root controls controls items anyOf item 8 allOf item 1 eventMappings eventMappings items attribute
Type: string

Attribute to be updated when the event is published.
root controls controls items anyOf DirectoryCombo
Type: object

root controls controls items anyOf item 9 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 9 allOf item 1
Type: object

root controls controls items anyOf item 9 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "DirectoryCombo"

root controls controls items anyOf item 9 allOf item 1 eventMappings
Type: array of object

Lists the attribute to be changed when the event is published by another control or the Windows Installer.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 9 allOf item 1 eventMappings eventMappings items
Type: object

root controls controls items anyOf item 9 allOf item 1 eventMappings eventMappings items event
Type: string

Name of the event to subscribe to. For a complete list of events, see https://learn.microsoft.com/en-us/windows/win32/msi/controlevent-overview

root controls controls items anyOf item 9 allOf item 1 eventMappings eventMappings items attribute
Type: string

Attribute to be updated when the event is published.
root controls controls items anyOf DirectoryList
Type: object
root controls controls items anyOf ProgressBar
Type: object

root controls controls items anyOf item 11 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 11 allOf item 1
Type: object

root controls controls items anyOf item 11 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "ProgressBar"

root controls controls items anyOf item 11 allOf item 1 eventMappings
Type: array of object

Lists the attribute to be changed when the event is published by another control or the Windows Installer.

 No Additional Items

Each item of this array must be:

root controls controls items anyOf item 11 allOf item 1 eventMappings eventMappings items
Type: object

root controls controls items anyOf item 11 allOf item 1 eventMappings eventMappings items event
Type: string

Name of the event to subscribe to. For a complete list of events, see https://learn.microsoft.com/en-us/windows/win32/msi/controlevent-overview

root controls controls items anyOf item 11 allOf item 1 eventMappings eventMappings items attribute
Type: string

Attribute to be updated when the event is published.
root controls controls items anyOf VolumeCostList
Type: object
root controls controls items anyOf PathEdit
Type: object
root controls controls items anyOf ScrollableText
Type: object

root controls controls items anyOf item 14 allOf BaseControl
Type: object
Same definition as controls_items_anyOf_i0_allOf_i0
root controls controls items anyOf item 14 allOf item 1
Type: object

root controls controls items anyOf item 14 allOf item 1 type
Type: enum (of string)

Must be one of:

  • "ScrollableText"

root controls controls items anyOf item 14 allOf item 1 text
Type: string

The Rich Text Format (RTF) content to be displayed. You can also reference a *.rtf file asset by name.