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 drop down.
- How to use it: Enter the text.
- Other notes: This must be unique. It is prefixed with ddl.
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.
Related Grid
- What it does: Grid the control updates, if any.
- How to use it: Select from the available grids.
Entity Field
- What it does: Column that contains the value.
- How to use it: Enter the entity and 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 name.
Object Field
- What it does: Column the value comes from.
- How to use it: Enter the column.
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: Enter the rule or select it 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 hard or soft error rules that check validity of the user input.
- How to use it: Enter the rule or click the magnifying glass icon and select the rule(s).
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.
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.
Operator
- What it does: SQL operator used in the appended where clause.
- How to use it: Select the operator.
- Other notes: Drop downs use the '=' operator.
Load Type
- What it does: Determines how the system populates the cascading drop down values.
- How to use it: Select from the drop down.
- Other notes: Options are:
- Code Group: The system populates the drop down with values from the codes value (this is most common).
- Query: The system executes a query to populate the drop down (this is second most common).
- Method: The system executes a method (local) to populate the drop down.
- Server Method: The system executes a server method to populate the drop down.
- Items: The system populates the drop down with manually entered values.
Code Group
- What it does: Code table ID for the code ID-value pairing that populates the drop down.
- How to use it: Enter the ID or select from the list or perform a search.
- Other notes: This only displays if Load Type is Code Group.
Query
- What it does: Query that populates the drop down.
- How to use it: Enter the query or select from the list or perform a search.
- Other notes: This only displays if Load Type is Query.
Method
- What it does: Method that populates the drop down.
- How to use it: Enter the method or select from the list or perform a search.
- Other notes: This only displays if Load Type is Method or Server Method.
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.
Plus icon
- What it does: Adds an item to the drop down.
- How to use it: Click the icon and enter text.
- Other notes: This only displays if Load Type is Items.
Minus icon
- What it does: Removes an item from the drop down.
- How to use it: Select the item and click the icon.
- Other notes: This only displays if Load Type is Items.
Text Field
- What it does: Text that displays if Load Type is Code Group, Query, or Items.
- How to use it: Select from the list. (Code Group populates automatically.)
Value Field
- What it does: Stored value if Load Type is Code Group, Query, or Items.
- How to use it: Select from the list. (Code Group populates automatically.)
Image Field
- What it does: Populates the columns of the code value table with an image.
- How to use it: Select from the drop down.
- Other notes: The path of the image can be set to display the image for each of the values that the drop down populates. This only displays if Load Type is not Items.
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.
Client Visibility Source
- What it does: Determines the list of controls for client side visibility.
- How to use it: Enter the text.
Advanced Tab:
sfwFirstItemText
- What it does: Displays the default text in the drop down.
- How to use it: Enter the text.
This post is part of multiple topics: