Stratification
This control only supports the numeric data type.
This control is not meant as a replacement of IDEA's stratification control. It is used more in the way that a macro/parameter dialog developer specifies the stratification limits during development and/or runtime (runtime = via code). The dialog user can only accept or modify the limits. In general he can add or remove limit rows or modify the upper limit values.
This control works differently than IDEA's stratification control. The control exactly specifies the two range values. The lower limit value is calculated an upper limit + 10^-decimals.
Different than the IDEA stratification dialog SmartAnalyzer's stratification control is used in the following way:
- During the audit test specification time the content developer specifies the upper limits the stratification control shall support
- The user might be allowed to edit the values or might not be allowed to edit them
- To not allow editing the lower and upper values can be achieved by setting the property Enabled for this control to False. The control is only displaying the values which are used later by the macro.
- The second use case is that a content developer specifies a set of upper values and the user is later allowed to edit them.
In all cases it should be possible to set a list of upper values. The macro developer is responsible that these values are entered in an ascending order. The control shall take the values and calculate the lower values by its own.
Properties:
Alias of the logical input database associated with the control.
The tag ID or the field associated with the control.
If set to true, it means that the associated tags have to be interpreted as field names. This property is only available starting from IDEA version 10.1. Do not change it if you plan to use the dialog from a lower version of IDEA.
The name for the control that will be displayed in the report.
The order in which the controls will be displayed in the reports. This property is only available starting from IDEA version 10.1. Do not change it if you plan to use the dialog from a lower version of IDEA.
Defines whether or not the output of the control is stored when the parent dialog is closed. Its default value is true. In case this property is set to false the save-routine of SmartAnalyzer is not storing the data entered into the corresponding input control. True means the data will be stored ans is available when opening the dialog a second time. This property is only available starting from IDEA version 10.1. Do not change it if you plan to use the dialog from a lower version of IDEA.
If set to true, the control will be shown in the report. This property is only available starting from IDEA version 10.1. Do not change it if you plan to use the dialog from a lower version of IDEA.
| Property | Description |
|---|---|
| CustomDialogButtonVisible | Specifies if the Custom Dialog button will be visible. |
| Decimals | Specifies whether decimals shall be shown. The user can enter values with or without the thousand separator. It is not relevant whether the thousand separator is placed at the right place of a number. For the return value also the number of decimals is required because the macro might need it. |
| DeleteButtonEnabled | Enables the Delete button. |
| EditStartValue | Determines whether the start value (first lower limit value) is editable or not. Only the lower limit start value can be editable. All other lower limit values cannot be edited by the user. These values are set when clicking in the first empty row below the last filled row. |
| Increment | An increment value is used to calculate a new upper limit value. Increment can only contain values of type Double. By default Increment is zero. This means that no new upper limit value is suggested when clicking in the first empty row. Click in an empty row to add the lower limit value in red font color to the new row and to add the upper limit value in edit mode. In contrast to IDEA's stratification control it is possible to also accept incomplete rows. This means that if the user clicks in the next empty row by mistake but does not enter any upper limit value, this row will be ignored. The upper limit value must be greater than the lower limit value. |
| InsertButtonEnabled | Enables the Insert button. |
| ResetButtonVisible | Specifies if the Reset button will be visible. |
| StartValue | The first lower value entry is the start value of this control. Values of type Double are allowed. |
| UpperLimits | The upper limit of the control. |
The list of tags that will enable or disable the control. The list of tags will be added based on the following schema: <input database alias>^<tag ID>. This property is only available starting from IDEA version 10.1. Do not change it if you plan to use the dialog from a lower version of IDEA.
| Button | Description |
|---|---|
| Delete | Removes the currently highlighted row from the list. This button can be enabled or disabled |
| Insert Row | Adds a new row above the currently highlighted row. You cannot enter a row above the first row. This button can be enabled or disabled. |
| Reset | Resets the current list to the default list specified by the developer. This command also works after the user has modified the content and saved changes. This button is optional and can be set to ResetButtonVisible (true/false). |
| Input Assistance | This button provides an event that allows the developer to add his own sub-dialog window. This sub-window can have any code behind which can be used by the parameters dialog. This button is optional and can be set to CustomDialogButtonVisible (true/false). |