This covers the different elements/controls and parameters within IRE files. When editing manually, be very careful about syntax etc. Especially with Template files.
The first line of any IRE (or the first Section when using "Make IRE" in IniRedit) contains various setups for the ini file. These include:
Options:
Each different element begins with the same 5 parameters, separated by a 'pipe' ("|"):
{keyname} - The key as it appears in the ini - this matches the element to the ini key.
{helptext} - The helptext that shows for the element. Can be blank.
{Keylock} - Whether to lock the key to editing or not ("LOCK"
or "EDIT").
{KeyName} - A 'friendly' name for the key. Replaces complex key names. If blank, key name in ini used.
{ValueLock} - Lock/enable editing for the value against this key ("LOCK"
or "EDIT").
Warning: If you set a Friendly Key name and then set {AllowKeyEdit} to EDIT, then whenever you save your ini file from IniRedit – it will overwrite your key names in your ini file. If it is set to LOCK, then the original keynames in your ini file will be preserved.
for e.g.
_Windowcol1|Set the colour of the window|LOCK|Window Colour|EDIT|.....
All element parameters follow this:
{Type}
1 = Simple Combo - User can choose form list or enter own value
2 = Drop-down Combo - User must choose value from list.
Defaults to 1
{Sorted?}
Y=Sorted list
N=List appears in order specified in {List}
Defaults to N
{List}
Items separated by "#"
E.g:
..|LIST|2|Y|Red#Yellow#Blue#Green
{Input Method}
DIAG = double click cell to open file dialogue box to edit. Click to preview file. Free editing is disabled.
TEXT = Free text entry of files. Click to see file details (if file in free text exists)
Defaults to TEXT
{Type}
PIC = Picture file (Click to preview + see file details)
GEN = General Files (Click to see file details)
FILENAME = filename and extension only (no path)
Defaults to GEN
{Check}
CHECK=Check whether file of this name exists before accepting
ALLOW=Allow custom entered filenames in filename box (e.g. where specifying files to create).
Defaults to CHECK
{Extensions}
List of File Dialogue drop-down label paired with allowed extension, separated by “;”s
e.g.
“All files (*.*);*.*;PNG Files (*.png);*.png”
Constructed thus:
“All files (*.*)” = How this file filter displayed in dropdown. {Label}
“*.*” = What windows uses to filter files. {Filter}
So, basically:
{Label};{Filter};{Label};{Filter};{Label};{Filter} etc..
Be very careful with this bit – ensure you use “;” as separators; use the right syntax and that you have all Labels paired with Filters.
{Input Method}
FREE = Free text input
DIAG = Via folder picker dialogue
{Check}
Whether to check the folder exists or not.
CHECK = check
NOCHECK = no check
{Check}
CHECK =Check date/time entered correctly or in correct format
FREE=No check
Defaults to check.
{Type}
SHORT – short date e.g. 11/9/1996
LONG – long date
TIME – time only
CUSTOM – Uses string to shape output – uses string defined in {Custom}
{Custom}
String to shape output. See Google!
{Type}
INT – Integer
FLOAT – Floating point number (e.g. “234.12”)
Defaults to Integer
{Check}
CHECK – Checks entry is valid number and/or within ranges specified. Highlights + prompts if not.
FREE – no checking (can contain characters) – choose if you want to allow null values.
Defaults to FREE
{Minimum}{Maximum} – Checks number entered is in this range. Leave blank to not test max and min.
e.g.
…|NUM|INT|CHECK|-50|100
Checks an integer between -50 and 100
…|NUM|FLOAT|CHECK||30.57
Checks is a floating point number up to a maximum of 30.57, but with no minimum
…|NUM|INT|CHECK
Checks number is an integer.
{Type}
CHECK = Displays a checkbox. Checked box means key value set to Val2, else Val1
DDOWN = Displays as drop-down list. Means DVal can be seen
Defaults to CHECK
{Values} = Three values, separated by a “#”
Value 1 = ‘true’ value (e.g. checkbox ticked)
Value 2 = ‘false’ value (e.g. checkbox unticked)
Value 3 = ‘indeterminate’ value. If value in the key value does not math either the true or false value, gets set to this.
e.g. …|BOOL|CHECK|True#False#Indeterminate
ini key value pairs and subsequent output:
.ini: _iLikeCheese=True
Output: Checkbox Ticked.ini: _iLikeCheese=Violins
Output: Checkbox Indeterminate
{Type} - How color values recorded in key
ARGB = RGB values with transparency
RGB = RGB Values alone
RAW = Raw windows value
{Format} - What format RGB values in (Hex or decimal)
HEX = Hex value
DEC = Decimal values
{Mask} - String used to convert colours into values contained in ini.
For example, your colour ARGB may be: DD3F2D1C. However, these may be recording in your .ini as:
_background=DD,3F,2D,1C
A mask is used to tell IniRedit how to record a color in you .ini. By example, to achieve the above, the following mask would be used:
...FREECOL|ARGB|HEX|{A},{R},{G},{B}
If either A, R, G or B are found between the "{" and "}" then the relevant value is substituted. Another example:
.ini:
_Sts_testBG=A:FF;R:A1;G:A5;B:255
.ire:
...FREECOL|ARGB|HEX|A:{A};R:{R};G:{G};B:{B}
NB: Be very careful with your mask coding, as careless masks can cause errors.
{Delimiter}
Your choice of what to use as a replacement for carriage return. When 'returned' lines are saved to your ini, the carriage returns are replaced by this delimiter (re-inserted when ini loaded).
Rich textbox. Allows you to enter Rich Text into this box. Tip: You can drag/drop or copy/paste any text in RichText format (e.g. from word), meaning you can have bold/italics etc in your ini.
{Delimiter}
This is automatically inserted by IniRedit - do not add this value yourself.
Similar to RTEXT, but allows the user to set the delimiter via IniRedit when editing an ini file.
Allows you to enter a delimited list (values separated by a character) in the editor. You place the character that you want as the delimiter as the very first character of the expanding text box. Then just record each new list item by pressing return in the textbox. IniRedit will do the rest for you. Make sure that you keep what you want as the first item in the list on the same line as the delimiter - a return before the first item will result in a null value for 1st on list. For example:
Produces:
_Sts_Dlist=Mon|Tues|Wed|Thurs
You can globally enable/disable Section editing via the IRE Settings line (1st line). However, if the global is set to enable editing, you can disable editing of individual Sections. This is not available via the IRE EDIT process, and must be added manually to the IRE file. Format:
In the example file, "Example1.IRE" You'll see:
[Filebox Tests]|Example Section Lock|LOCK|||TEXT
You can also associate help text with individual sections this way, regardless on whether they are locked or not..