Homepage | About EASA | Contact
Sidebar
Table of Contents
INPUTBOX
Guide Section: GUI of EASAPs | EASAP Tree: USER INTERFACE Branch
INPUTBOX is a versatile data entry component that can be configured to behave in a variety of modes depending on the setting of the Input Type: parameter. The set of parameters available to specify will vary depending on the value selected in the Input Type: parameter. INPUTBOX can be used in place of the following data entry objects:
- CHOICE LIST
- REALBOX
- INTEGERBOX
- TEXTBOX
- DATEBOX
Additionally, an INPUTBOX can provide two data types not found in other data entry objects:
- Currency
- Percentage
 INPUTBOX |
|
|---|---|
| Optional Parameters: | |
| Label: | Text displayed to the left of box |
| Input Type: | Select the data type. (options listed below) |
| Default: | Default value to be displayed |
| Range Reference: | Select NAMED RANGE or existing RANGE REFERENCE to link value to cell in an Excel spreadsheet |
| Label Width: | Width in pixels of Label: |
| Label Style: | A reference to a USER INTERFACE STYLE that controls the visual appearance of this object's label. |
| Input Style: | A reference to a USER INTERFACE STYLE that controls the visual appearance of this object's input area. |
| Show if: | Logical expression, if TRUE then box shown, if FALSE then box NOT shown |
| Enable if: | Logical expression, if TRUE then box enabled, if FALSE then box NOT enabled |
| Tool Tip: | Text to be displayed as a tool tip |
| Decimal Places: | The number of decimal places shown |
| Thousand Separator: | Select whether to show a comma as a thousands separator. (TRUE, FALSE. default→FALSE) |
| Currency Symbol: | Select the currency symbol ($, £, €, ¥. Default→$) |
| Pattern: | Select a format for storage and display of date and time |
| Tab Index: | Establish an order of preference for <TAB> key navigation. Highest priority is the lowest number (default→1) and continues in ascending numerical order. Use -1 to disable. |
| Characters: | Width of INPUTBOX in characters |
| Show Date Button: | When set to TRUE, a BUTTON will be displayed next to the object which allows selection from a calendar. Only available if Input Type:'DateTime'. (default→TRUE) |
| Number Format Code: | Select the custom number format to show |
| Delimiter: | Character to act as delimiter in DORs on Label: and Default: above, when Input Type: is non-numeric. Replaces default of %. |
Child objects of INPUTBOX:
| Object Name | Description |
|---|---|
| CONDITIONAL FORMATTING | Used to change the appearance of an INPUTBOX when a certain condition applies. |
| DATA VALIDATION | Defines what data is allowed to be entered by users. |
| PARAMETRIC RANGE | Allows users to perform parametric studies with an EASAP. |
Input Type:
The Input Type: parameter is used to set the type of data entered into the INPUTBOX by the user. One of the aims of INPUTBOX was to be more compatible with cell values found in Excel spreadsheets. As such, the selections available for the Input Type: parameter reflect choices similar to what is available for cell formats in Excel. The behavior of INPUTBOX is that when the Input Type: parameter is set, then certain optional parameters will appear to allow further configuration of the object. The available data types for the Input Type: parameter and their effects on the INPUTBOX are shown below.
| Data Type | Effect | Optional Parameters |
|---|---|---|
| 'Currency' | Sets the data entered to be a number that will be shown with the specified currency symbol to the left of the number | Decimal Places: Currency Symbol: |
| 'Custom' | Set the data entered to be a custom format as specified by the selected format in the Number Format Code: parameter | Decimal Places: Thousand Separator: Currency Symbol: Number Format Code: |
| 'DateTime' | Sets the data entered to be a date and/or time stored and shown in the form specified by the Pattern: parameter | Pattern: |
| 'General' | Allows any form of data to be entered | - |
| 'Number' | Sets the data entered to be a number | Decimal Places: Thousand Separator: |
| 'Percentage' | Sets the data entered to be a number represented as a percentage with % symbol shown after the number | Decimal Places: |
| 'Text' | Sets data entered will be treated as text, even if it is numerical | - |
Note: The value of an INPUTBOX when Input Type: is set to ‘Percentage’ is actually the decimal value, so the value shown has been multiplied by 100.