Edit.INI Var Field
The Edit .INI Var Field tool in the Standard library enables you to draw a field that can be used to set the value of a specific Config.ini variable for your application.
Note: Information on all Config.ini variables is provided in the VTS Programmer's Guide: Introduction to Config.ini.
The result of the above configuration is an edit field labeled, "Display Manager Logo". Operators can type the name of a bitmap (located in the application directory) to modify the appearance of the display manager.
Note: Some Config.ini variables (like DispMgrFullScreen) require that your application be restarted before their value can be read. Others allow you to modify your application's behavior without requiring a restart if you select the Update RAM Copy checkbox.
For each Config.ini variable whose value you wish to modify, you must create a new Edit .INI Var Field object. If you wish to set a Config.ini variable that accepts a value of either 0 or 1, use the Edit.INI Checkbox tool.
Note: You may not wish operators to have access to the configuration file settings for your applications. It is therefore recommended that you configure a reserved application page, place all your Edit .INI Var Field objects on it, and then protect it from operator access using an application privilege (please refer to Protect a Page with an Application Privilege).
(Click title to expand text)
The Section field enables you to enter the name of the section in Config.ini under which the variable you wish this field to modify appears. For example, if the variable appears under the [LABELS] section heading in Config.ini, enter "Labels" in the Section field. If the variable appears under the [SYSTEM] section in Config.ini, enter "System" in the Section field.
Provide the name of the Config.ini variable that this edit field will enable users to edit.
Enter the text label that you wish to be displayed above the completed edit field.
The Data Type drop-down list enables you to select the data type accepted by the specified Config.ini variable. A “data type” is a programming term referring to the specific type of value that is permissible for a variable. Some variables require text settings, others require numeric settings that might be small or large, while others require a specific value of "0" or "1".
The available data types are:
• Status: Status is a numeric data type that can have a value of 0 or 1 (i.e. off/on or false/true).
• Long: Long is a numeric data type that is a whole number 4 bytes in length (i.e. -2147483 to 2147483).
• Short: Short is a numeric data type that is a whole number 2 bytes in length (i.e. -32767 to 32767).
• Float: Float is a numeric data type that is a fractional or decimal point value (e.g. 327.983).
• Text: Text is a text data type that accepts alphanumeric characters (e.g. "My Application").
Enter the minimum value that the selected variable will accept based on its data type (see above). Note: For text data types, the minimum value represents the minimum number of characters the variable will accept.
Enter the maximum value that the selected variable will accept based on its data type (see Minimum Value). Note: For text data types, the maximum value represents the maximum number of characters the variable will accept.
Indicates how you wish the completed edit field to appear. This can be one of:
• Invisible: The Edit .INI Var Field object will be invisible to users. You may choose this option if you wish to hide the object from view, and set it to Force Normal whenever you wish to use it.
• Force Normal: The Edit .INI Var Field object will be enabled and visible.
• Gray If Appropriate: The Edit .INI Var Field object will be enabled when the associated Config.ini variable cannot be set.
Specifies the alignment to be applied to the edit field, and its title and bevel vertically within its drawing area. You may select one of:
• Top: The Top radio button indicates that the edit field, its title (if the Align Title checkbox has been selected), and its bevel (if the Draw Bevel checkbox has been selected) will be aligned to the vertical top of its drawing area.
• Centered: The Centered radio button indicates that the edit field, its title (if the Align Title checkbox has been selected), and its bevel (if the Draw Bevel checkbox has been selected) will be aligned to the vertical center of its drawing area.
• Bottom: The Bottom radio button indicates that the edit field, its title (if the Align Title checkbox has been selected), and its bevel (if the Draw Bevel checkbox has been selected) will be aligned to the vertical bottom of its drawing area.
Indicates whether or not you wish a beveled border to be drawn around your edit field. If the Draw Bevel checkbox is selected, then a beveled border will appear around the completed edit object. If the Draw Bevel checkbox is not selected, then a beveled border will not appear around the completed object.
Indicates whether or not you wish the height of the title to be factored into the vertical alignment calculations (see Vertical Alignment above). If the Align Title checkbox is selected, then the title will be factored into the vertical alignment calculations. If the Align Title checkbox is not selected, then the title will not be factored into the vertical alignment calculations.
Enables you to choose whether or not you wish the value entered for the associated variable to be instantly updated in your PC's RAM.
If selected, the associated Config.ini variable's value will be automatically updated whenever a value is entered into this edit field.
If this checkbox is not selected, you must stop and restart the application each time you have entered a new value into this edit field before the new value will take effect.
The Focus ID spin box enables you to select a number representing the order of the completed object in the overall tab order.