This item is found in multiple S3 file types. Its controls and their order may vary based on the file type.
General Tab:
ID
- What it does: Programmatic ID of the control.
- How to use it: Enter the text.
- Other notes: This must be unique. It is prefixed with txt.
Visible checkbox
- What it does: Determines whether the user can see the control.
- How to use it: Click the checkbox to check or uncheck.
Mode
- What it does: Determines whether the way the user opened the form affects the control. Options are All, New, and Update. All means that regardless of whether the user created new or opened existing, the control behaves the same. New is for creating new and Update is for opening existing.
- How to use it: Select from the drop down.
- Other notes: It defaults to All.
Visible Rule
- What it does: Displays the control if it evaluates to true. Hides the control if it evaluates to false.
- How to use it: Enter the rule from the entity.
- Other notes: The rule comes from the entity. It must be configured there for you to use it here.
Resource
- What it does: Security ID that determines whether the user can access the control.
- How to use it: Enter the ID from the security table.
CSS Class
- What it does: Custom style sheet class that controls cell appearance.
- How to use it: Enter the text.
- Other notes: If left blank, the appearance is default. The class must be configured in the MVVM project style sheet in the .NET project.
Custom Attributes
- What it does: Custom attribute defined by the developer to be rendered on the HTML page.
- How to use it: Enter the text.
Data Format
- What it does: Restricts valid text entry to a specific format.
- How to use it: Select the desired format.
- Other notes: Format options include date, currency, percent, SSN, and phone number.
Related Grid
- What it does: Grid the control affects.
- How to use it: Select from the available grids.
Entity Field
- What it does: Displays the associated entity field.
- How to use it: Enter the column.
Query ID
- What it does: Entity whose table contains the column.
- How to use it: Enter the entity.
Data Field
- What it does: Column that contains the value.
- How to use it: Enter the column.
Data Type
- What it does: Identifies the data as string, numeric, decimal, or datetime.
- How to use it: Select the desired option.
Operator
- What it does: SQL operator used in the appended where clause.
- How to use it: Select the operator.
Width
- What it does: Pixel width of the control.
- How to use it: Enter the number of pixels.
- Other notes: This defaults to the width of the cell.
Default Value
- What it does: Interacts with the Default Type to assign a value to the control.
- How to use it: Options are:
- If Default Type is None or TextValue, enter text.
- If Default Type is TodaysDate or TodaysDateTime, keep this null.
- If Default Type is MethodOnServer, enter a valid method in the entity that returns a string value.
- If Default Type is MethodOnClient, enter a valid method defined in default.aspx.cs that returns a string value.
- If Default Type is System Constant, enter a code_value from sgs_code_value where code_id 52.
- If Default Type is Scalar Query, enter a valid query from the entity that returns a scalar value.
Default Type
- What it does: Interacts with the Default Value to assign a value to the control.
- How to use it: Select from the drop down.
- Other notes: The default is None. Other options are TextValue, TodaysDate, TodaysDateTime, MethodOnServer, MethodOnClient (in webforms only), System Constant, and Scalar Query.
Related Control
- What it does: Control whose method executes when the user clicks the value if it is clickable.
- How to use it: Select from the list of available controls.
Allow Soundex
- What it does: Enables phonetic search.
- How to use it: Click the checkbox to check or uncheck.
Text Mode
- What it does: Determines the appearance of the text on the form.
- How to use it: Select from the available modes.
Rows
- What it does: Number of lines if the Text Mode is MultiLine.
- How to use it: This is read-only.
- Other notes: You can set this on the Properties tab.
Item Read Only Rule
- What it does: Rule that determines whether the value is editable when the user opens the form in update mode.
- How to use it: Type or select from the available rules.
- Other notes: The rule must come from the entity and be an Initial Load validation.
Validation Rules
- What it does: Rule or collection of rules for hard errors or soft errors that check validity of the user input.
- How to use it: Enter the rule name or click the magnifying glass and select the rule(s).
Set Client Visibility button
- What it does: Opens a window that allows setting conditions under which the control is visible.
- How to use it:
- Click the button.
- Populate the Control List.
- Set the Value-Visible Control pairings.
- Click OK.
Set Client Enable button
- What it does: Opens a window that allows setting conditions under which the control is enabled.
- How to use it:
- Click the button.
- Populate the Control List.
- Set the Value-Visible Control pairings.
- Click OK.
Retrieval Panel:
Query radio button
- What it does: Executes a query to retrieve values for populating controls.
- How to use it: Click the button to select.
Method radio button
- What it does: Executes a method to retrieve values for populating controls.
- How to use it: Click the button to select.
Retrieval Query
- What it does: Query that executes to retrieve values to populate selected controls.
- How to use it: Enter the query or select from the list or search for the query.
- Other notes: This control only displays if the Query option is selected.
Retrieval Method
- What it does: Method that executes to retrieve values to populate selected controls.
- How to use it: Enter the method or select from the list or search for the method.
- Other notes: This control only displays if the Method option is selected.
Parameters
- What it does: Configures query/method parameters with form controls.
- How to use it: Click the magnifying glass and drag the control(s) to the parameter field(s).
- Other notes: Text entry is not possible. Queries/methods without parameters don't need this.
Retrieval Controls
- What it does: Controls that are populated when the application executes the retrieval query or method.
- How to use it: Click the magnifying glass and drag the table column(s) to the form control(s).
- Other notes: Text entry is not possible.
Auto Complete Panel:
Query
- What it does: Query the application executes to find matching values to populate the drop down of available auto complete selections.
- How to use it: Enter the query address (entName.QueryID) or browse for the query.
Auto Complete Query
- What it does: Query the application executes to find matching values to populate the drop down of available auto complete selections.
- How to use it: Enter the query address or browse for the query.
Parameters
- What it does: Configures query parameters with form controls.
- How to use it: Click the magnifying glass and drag the control(s) to the parameter field(s).
- Other notes: Text entry is not possible. Queries without parameters don't need this.
Columns
- What it does: Columns the application uses to populate the drop down of available auto complete selections.
- How to use it: Click the magnifying glass and select the column(s). Click the arrow to add. Enter the desired operators.
- Other notes: Text entry is not possible. The operator is usually 'like'.
Control Mapping
- What it does: Control the selected auto complete option populates.
- How to use it: Click the magnifying glass and drag the desired column to the desired control.
- Other notes: Text entry is not possible.
Minimum Length
- What it does: Number of characters the user enters before the application displays a list of <21 possible matches.
- How to use it: Enter the number of characters.
- Other notes: This defaults to 3.
Delay
- What it does: Number of milliseconds following the entry of the last character before the application displays the list of options.
- How to use it: Enter the number of milliseconds.
- Other notes: This defaults to 1000.
This post is part of the HTML Forms topic. Click here to open the HTML Forms Overview.