The INI file has one required section. This section includes the
number of controls to be created as well as general window
attributes. The INI file also includes a variable number of Field
sections which are used to create the controls to be displayed.
Each field section has the heading "Field #" where # must be
sequential numbers starting at 1. Each Field section can
contain the following values:
| Type |
|
Type of control to be created. Valid values
are: |
|
Label |
Used to display static text (i.e. a caption for a textbox). |
|
Text |
Accepts text input from the user. |
|
Password |
Accepts password input from the user.
The input is masked with * characters. |
|
IPAddress |
Displays an edit box used for IP address input. |
|
HotKey |
Displays an edit box used to get keyboard input. |
|
UpDown |
Displays a pair of arrow buttons
that the user can click to increment or decrement a number in a Text or
ComboBox buddy controls, to change the selection upwards or downwards
of a ListBox control, or to be used alone (without the user knowing what
number he/she selected). See Text, State and Left Right Top
Bottom commands for more information on how to use it on the specified
situations. |
|
Combobox |
Allows the user to type text not in the popup
list. |
|
DropList |
Only allows selection of items in the
list. |
|
Listbox |
Shows multiple items and can optionally allow
the user to select more than one item. |
|
CheckBox |
Displays a check box with label. |
|
RadioButton |
Displays a radio button with label. |
|
FileRequest DirRequest |
Use Text and Button
controls to make one that fits your style. |
|
Icon |
Displays an icon. Use no "Text" to use the
installer icon. |
|
Bitmap |
Displays a bitmap. |
|
Animation |
Displays an AVI video. Has to be
without sound. |
|
ProgressBar |
Displays a bar to show progress. |
|
TrackBar |
Displays a bar where the user can select with
the slider one of the options indicated by ticks. It doesn't include labels. |
|
DateTime |
Displays a combo box where the user can pick or select a
date or time he/she wants.
Minimum OS: Win 95 w/ IE 3.0, Win NT 4.0 w/ IE 3.0. |
|
MonthCalendar |
Displays a month calendar where the user can select
a date he/she wants.
Minimum OS: Win 95 w/ IE 3.0, Win NT 4.0 w/ IE 3.0. |
|
GroupBox |
Displays a frame to group
controls. |
|
Link |
Displays a static hot text. When the user
clicks the control the contents of State (e.g.
http://...) will be executed using ShellExecute. Alternatively
State can be omitted and the NOTIFY flag
used to have your NSIS script called. See the "NOTIFY"
flag below for more information. |
|
Button |
Displays a push button that can be used
in the same way as the "Link" control above. |
| |
| Text |
|
Generally specifies control caption, but this can
depend on the control type: |
|
UpDown |
(Input) Specifies the buddy control field number (where the UpDown
attaches itself into another). Recommended types of buddy controls are: Text, ComboBox and
ListBox. If you don't want to have a buddy control, you have to leave this as blank. |
|
Label Checkbox RadioButton |
(Input) Specifies the control caption.
Note: For Label controls, \r\n will be converted to a
newline. To use a back-slash in your text you have to escape it
using another back-slash - \\. Described below. |
|
Icon Bitmap Animation |
(Input) Specifies the path to a file for its type. |
|
ComboBox DropList |
(Input) Specifies the bitmap file to load
containing a slot for each item in the list specified by "ListItems". Each bitmap
slot (for each list item) is 16x16 pixels long, with transparent color set to
#FF00FF (format #RRGGBB). Limit of 256 bitmap slots for now. The slots have to be
ordered as the list items. |
|
DateTime |
(Input) Specifies the format to show
State. Default is the date format specified by the user
in the Regional and Language Options from Control Panel.
The format explainations can be found there about Date and Time. |
|
Button |
(Input) Specifies control's text. If ICON or
BITMAP flags are associated with a button control, this specifies the path
where the icon or bitmap are. |
| |
| State |
|
Specifies the state of the control. This is
updated when the user closes the window, so you can read from it
from NSIS. The input/output depends on the control type: |
|
Edit Password IPAddress |
(Input/Output) String to appear (or last appeared). |
|
HotKey |
(Input/Output) String to appear (or last appeared).
Each key has to start with each word first letter capitalized, except standalone
keys which have to be in lower case (like Ctrl + Alt + Shift + c). Each
combination has to be separated by " + ", so the key "+" is not supported yet. |
|
UpDown |
(Input/Output) Specify the number
of the option selected. NOTE: If a UpDown control
has its buddy control a Text control, it will replace its
state for UpDown's. |
|
RadioButton CheckBox |
(Input/Output) '0' or '1' (for unchecked or checked). |
|
ListBox |
(Input/Output) Selected items separated by pipes ('|'). |
|
ComboBox DropList |
(Input/Output) Selected item name. |
|
ProgressBar |
(Input/Output) Specify at what point
the progress is. Maximum limit is 100 when MaxLen
is not specified. |
|
TrackBar |
(Input/Output) Specify the number
of the option selected. |
|
DateTime |
(Input/Output) Specify the date and
time to show. Has to be based on this format:
d/m/yyyy h:m:s w (w = day of the week
as a number -> Sunday = 0, Monday = 1...)
The separators can be:
"/", "\", "-", ":" or " ".
If you don't want to specify all those numbers, you can just keep it empty,
i.e.:
27//2003
Only will be used the day and the year.
|
|
Link |
(Input) Specify something to be executed or opened
(like "Exec" command from NSIS). |
|
Button |
(Input) Specify something to be executed or opened
(like "Exec" command from NSIS). If you specify FILEREQUEST or
DIRREQUEST flags this specify to what control field number the result value
will be returned. Recommended controls are: Text and ComboBox controls. |
| |
| ListItems |
|
(Input) A list of items to display in a "ComboBox",
"DropList" or "Listbox".
This is a single line of text with each item separated by a pipe
character '|' |
| |
| MaxLen |
|
(Input) Causes validation on the selected control to
limit the maximum length of text (or options).
If the user specifies more text than this, a message box will
appear when they click "OK" and the dialog will not be
dismissed. |
|
Text |
If the control has FILEREQUEST or DIRREQUEST
flags, this should be set to 260.
|
|
ComboBox |
You should not use this with
this control since the user can not control what is selected. |
|
Animation |
Is the ending frame of the animation. -1 is the last frame animation. |
|
ProgressBar TrackBar |
This limits the number of maximum
progress/options.
|
| |
| MinLen |
|
(Input) Causes validation on the selected control to
force the user to enter a minimum amount of text.
If the user specifies less text than this, a message box will
appear when they click "OK" and the dialog will not be
dismissed. |
|
ComboBox |
If you set this to "1" the
program will force the user to select an item.
|
|
Animation |
Is the starting frame of the animation. 0 is the first frame. |
|
ProgressBar |
Is the value when the progress
starts. If State is lower than this value, the progress
won't show up. |
|
TrackBar |
Is the starting option number. |
| |
| ValidateText |
|
(Input) If the field fails the test for
"MinLen" or "MaxLen", a messagebox will be
displayed with this text.
Note: \r\n will be converted to a newline. To use a back-slash
in your text you have to escape it using another back-slash - \\.
Described below. |
| |
Left
Right
Top
Bottom |
|
(Input) The position on the dialog where this
control appears. All sizes should be set in dialog units. To get
the right dimensions for your controls, design your dialog using a
resource editor and copy the dimensions to the INI file.
Note: You can specify negative coordinates to
specify the distance from the right or bottom edge. |
|
ComboBox DropList |
The Bottom value is not used
in the same way. In this case, the bottom value is the maximum size
of the window when the pop-up list is being displayed. All other times,
the combobox is automatically sized to be one element tall. If you have
trouble where you can not see the combobox drop-down, then check
the bottom value and ensure it is large enough. A rough guide for
the height required is the number of items in the list multiplied
by 8, plus 20. |
|
ProgressBar |
When using XPStyle on, the minimum
height (or width if using VERTICAL flag) has to be above 5 dialog units
or the ProgressBar will not be redrawn right. |
|
MonthCalendar |
Recommended size: 131x95. |
| |
| Filter |
|
(Input) Specifies the filter to be used in the
Text controls that use FILEREQUEST flag.
This is constructed by putting pairs of entries together, each item
separated by a | character.
The first value in each pair is the text to display for the
filter.
The second value is the pattern to use to match files.
For example, you might specify:
Filter=Text Files|*.txt|Programs|*.exe;*.com|All Files|*.*
If not specified, then the filter defaults to All Files|*.*
Note: you should not put any extra spaces around
the | characters. |
| |
| Root |
|
(Input) Used by "DirRequest" control to specify the root
directory of the search. By default, this allows the user to browse
any directory on the computer. This will limit the search to a
particular directory on the system. |
| |
| Flags |
|
(Input) This specifies additional flags for the
display of different controls. Each value should be separated by a
| character, and you should be careful not to put any spaces around
the | character.
| Value |
Meaning |
| GROUP |
Add this flag to the first control of a
group of controls to group them. Grouping controls allows you to
create multiple groups of radio button and makes keyboard
navigation using arrow keys easier. |
| REQ_SAVE |
This causes Button controls with FILEREQUEST flag
to display a Save As dialog. If not specified, an Open dialog is
used. |
| FILE_MUST_EXIST |
Used by Button controls with FILEREQUEST flag
to determine if the selected file must exist.
This only applies if an "Open" dialog is being displayed.
This currently does not force the file to exist other than through
the browse button. |
| FILE_EXPLORER |
Used by Button controls with FILEREQUEST
flag, enables new file request look (recommended) |
| FILE_HIDEREADONLY |
Used by Button controls with FILEREQUEST flag,
hides "open read only" checkbox in open dialog. |
| WARN_IF_EXIST |
Used by Button controls with FILEREQUEST flag
to display a warning message if the selected file already exists.
The warning message is only displayed for files selected with the
browse button. |
| PATH_MUST_EXIST |
Used by Button controls with FILEREQUEST flag
to force the path to exist. Prevents the user from typing a non-existent path
into the browse dialog window.
This only validates path's selected with the browse button. |
| PROMPT_CREATE |
Used by Button controls with FILEREQUEST flag
to display a warning if the selected file does not exist. However, it still
allows the user to select the file.
This only displays the warning for files selected with the browse
button.
Doesn't work along with REQ_SAVE. |
| RIGHT |
Used by CheckBox and
RadioButton controls to specify you want the checkbox to
the right of the text instead of the left as is the default. |
| MULTISELECT |
Used by ListBox controls. Turns
string selection on or off each time the user clicks or
double-clicks a string in the list box. The user can select any
number of strings. If this flag and EXTENDEDSELCT are not
specified, only one item can be selected from the list. |
| EXTENDEDSELCT |
Used by ListBox controls. Allows
multiple items to be selected by using the SHIFT key and the mouse
or special key combinations. If this flag and MULTISELECT are not
specified, only one item can be selected from the list. |
| RESIZETOFIT |
This causes Bitmap controls to
resize the image to the size of the control. Also useful to support
custom DPI settings. Without this, the image will be centered
within the specified area. |
| NOTABSTOP |
Do not stop on the control when the user
pressed the Tab key. Add NOTABSTOP to all controls of a group
except the first one to allow navigation between groups with the
Tab key. |
| DISABLED |
Causes a control to be disabled. |
| ONLY_NUMBERS |
Used by Text controls. Forces the
user to enter only numbers into the edit box. |
| MULTILINE |
Used by Text controls. Causes the
control to accept multiple-lines. |
| WANTRETURN |
Used by Text controls with
multiple-line. Specifies that a carriage return be inserted when
the user presses the ENTER key while entering text into the text
box. |
| NOWORDWRAP |
Used by Text controls with
multiple-line. Disables the word-wrap that occurs when long lines
are entered. Long lines instead scroll off to the side. Specifying
the HSCROLL flag also has this effect. |
| HSCROLL |
Show a horizontal scrollbar. When used by
"Text" controls with multiple-lines this also disables
word-wrap. |
| VSCROLL |
Show a vertical scrollbar. |
| READONLY |
Used by Text controls. Prevents
the user from entering or editing text in the edit control, but
allow the user to select and copy the text. |
| NOTIFY |
Used by Text, Password, IPAddress,
UpDown, ComboBox, DropList, ListBox,
CheckBox, RadioButton, Animation, Animation,
DateTime, MonthCalendar
Button and Link controls. Causes InstallOptionsEx
to call your NSIS custom page validation/leave function whenever the
control's selection changes. Your validation/leave function can read the
State value from the Settings section to
determine which control caused the notification, if any, and
perform some appropriate action followed by an Abort instruction
(to tell NSIS to return to the page). The Contrib\InstallOptionsEx
folder contains an example script showing how this might be
used. |
| CENTER |
Used by Animation controls. Makes the animation
centered.
|
| SMOOTH |
Used by ProgressBar controls. Makes the progress bar
smooth.
Minimum OS: Win 95 w/ IE 3.0, Win NT 4.0 w/ IE 3.0.
|
| VERTICAL |
Used by ProgressBar controls. Makes the progress bar
to appear as a vertical progress bar with the indicator bar starting from bottom.
Minimum OS: Win 95 w/ IE 3.0, Win NT 4.0 w/ IE 3.0.
|
| BACK_RECT |
Used by Trackbar controls. Makes the control
show a white rectangle where the slider passes on.
|
| TOOLTIPS |
Used by Trackbar controls. Makes the control
show tooltips when the user changes the slider position.
Minimum OS: Win 95 w/ IE 3.0, Win NT 4.0 w/ IE 3.0.
|
| NO_TICKS |
Used by Trackbar controls. Makes the control
do not show ticks on the entire control.
|
| BITMAP |
Used by Button controls. Makes the control
show a bitmap instead of text. Don't use this with ICON flag.
|
| ICON |
Used by Button controls. Makes the control
show an icon instead of text. Don't use this with BITMAP flag.
|
| UPDOWN |
Used by DateTime controls. Makes the control
like the UpDown control from Windows, but using date and time.
|
| NOTODAY |
Used by MonthCalendar controls. Makes the control
to do not display the "today" date at the bottom of the control. Recommended control height is 75.
|
| NOTODAYCIRCLE |
Used by MonthCalendar controls. Makes the control
to do not circle the "today" date.
|
| WEEKNUMBERS |
Used by MonthCalendar controls. Makes the control
to display week numbers (1-52) to the left of each row of days.
Week 1 is defined as the first week that contains at least four days.
Recommended control width is 134.
|
| FILEREQUEST |
Used by Button controls. Makes the control
to display a common dialog requiring a file for input. See State option
for more details on how to output it to another control.
|
| DIRREQUEST |
Used by Button controls. Makes the control
to display a common dialog requiring a directory for input. See State option
for more details on how to output it to another control.
|
| LEFT |
Used by UpDown controls. Makes the control
to position to the left of its buddy control. If it doesn't have a buddy control,
it will be ignored.
|
| HORIZONTAL |
Used by UpDown controls. Makes the arrows of
the control to point left and right instead of up and down.
|
| WRAP |
Used by UpDown controls. Makes the position
to "wrap" if it is incremented or decremented beyond the ending or beginning of
the range.
|
|
| |
| TxtColor |
Label Link Text |
Specifies the foreground color of the text.
Format: 0xBBRRGG (hexadecimal). |
|
ListBox DropList |
Specifies the foreground color of the text when an
item is not selected. Format: 0xBBRRGG (hexadecimal). |
|
ComboBox |
Specifies the foreground color of the text when an
item is not selected and when not using the images feature. This is not drawn on
the Text box part of ComboBox. Format: 0xBBRRGG (hexadecimal). |
|
ProgressBar |
Specifies the color of the indicator bar.
Format: 0xBBRRGG (hexadecimal). |
|
MonthCalendar DateTime |
Specifies the foreground color of the normal days
text in the controls' calendar. Format: 0xBBRRGG (hexadecimal). |
| |
| BgColor |
Label Link Text |
Specifies the background color of the text.
Format: 0xBBRRGG (hexadecimal). |
|
ListBox DropList |
Specifies the background color of the text when an
item is not selected. Format: 0xBBRRGG (hexadecimal). |
|
ComboBox |
Specifies the background color of the text when an
item is not selected and when not using the images feature. This is not drawn on
the Text box part of ComboBox. Format: 0xBBRRGG (hexadecimal). |
|
ProgressBar |
Specifies the color of the background part of the bar.
This only is used when not using Windows themes. Format: 0xBBRRGG (hexadecimal). |
|
MonthCalendar DateTime |
Specifies the background color of the month calendar.
Format: 0xBBRRGG (hexadecimal). |
| |
| SelTxtColor |
ListBox DropList |
Specifies the foreground color of the text when an
item is selected. Format: 0xBBRRGG (hexadecimal). |
|
ComboBox |
Specifies the foreground color of the text when an
item is selected and when not using the images feature. This is not drawn on
the Text box part of ComboBox. Format: 0xBBRRGG (hexadecimal). |
|
MonthCalendar DateTime |
Specifies the foreground color of the month calendar
selected text and title text. Format: 0xBBRRGG (hexadecimal). |
| |
| SelBgColor |
ListBox DropList |
Specifies the background color of the text when an
item is selected. Format: 0xBBRRGG (hexadecimal). |
|
ComboBox |
Specifies the background color of the text when an
item is selected and when not using the images feature. This is not drawn on
the Text box part of ComboBox. Format: 0xBBRRGG (hexadecimal). |
|
MonthCalendar DateTime |
Specifies the background color of the month calendar
selected text and title text. Format: 0xBBRRGG (hexadecimal). |
| |
| MonthOutColor |
MonthCalendar |
Specifies the background color of the outside part of
the month calendar. This is only used when you specify a bigger control size
than the recommended one. Format: 0xBBRRGG (hexadecimal). |
| |
| MonthTrailingTxtColor |
MonthCalendar DateTime |
Specifies the foreground text color of the days from
the last or next month being shown. Format: 0xBBRRGG (hexadecimal). |
| |
| FontName |
|
Unavailable at this time. |
| |
| FontHeight |
Label Link |
Sets the control font height. |
|
ListBox DropList
ComboBox |
Sets the control font height. If the cuts off,
you can adjust the parameter ListItemsHeight. |
|
Text |
Sets the control font height. It is not recommended
to increase the font size because the text can cut off. |
| |
| FontHeight |
Label Link |
Sets the control font height. |
|
ListBox DropList
ComboBox |
Sets the control font height. If the text cuts off,
you can adjust the parameter ListItemsHeight. |
|
Text |
Sets the control font height. It is not recommended
to change this because the text can cut off. |
| |
| FontEscapement |
Label Link |
Sets the control font escapement in degrees times 10.
Example: 900 = 90 degrees. |
|
ListBox DropList
ComboBox |
Sets the control font escapement in degrees times 10.
Example: 900 = 90 degrees. If the cuts off, you can adjust the parameter
ListItemsHeight. |
|
Text |
Sets the control font escapement in degrees times 10.
Example: 900 = 90 degrees. It is not recommended to change this
because the text can cut off. |
| |
| FontOrientation |
|
Only supported by: Windows NT/2000/XP. Requires a graphics driver that
have the advanced graphics mode option. |
|
Label Link |
Sets the control font orientation in degrees times 10.
Example: 900 = 90 degrees. |
|
ListBox DropList
ComboBox |
Sets the control font orientation in degrees times 10.
Example: 900 = 90 degrees. If the cuts off, you can adjust the parameter
ListItemsHeight. |
|
Text |
Sets the control font orientation in degrees times 10.
Example: 900 = 90 degrees. It is not recommended to change this
because the text can cut off. |
| |
| FontBold |
Label Text ListBox
DropList ComboBox Link |
If set to 1, this makes the text to become bold. |
| |
| FontItalic |
Label Text ListBox
DropList ComboBox Link |
If set to 1, this makes the text to become italic. |
| |
| FontUnderline |
Label Text ListBox
DropList ComboBox Link |
If set to 1, this makes the text to have an underline. |
| |
| FontStrikeOut |
Label Text ListBox
DropList ComboBox Link |
If set to 1, this makes the text to have a strike out. |