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 chk.
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.
Enable Rule
- What it does: Displays the control normally if it evaluates to true. Grays out 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.
Query ID
- What it does: Entity whose table contains the column.
- How to use it: Enter the entity.
Data Field
- What it does: Column whose value is linked to the control.
- How to use it: Enter the column.
Object Field
- What it does: Column the value comes from.
- How to use it: Enter the column.
Related Grid
- What it does: Grid the control is used to update, if any.
- How to use it: Select from the drop down.
Entity Field
- What it does: Entity whose value is linked to the control.
- How to use it: Enter the entity.
CheckBox Field
- What it does: Column whose value is linked to the control.
- How to use it: Enter the column.
Checked Value
- What it does: Value used in the where clause appended to the query if the checkbox is checked.
- How to use it: Enter the value.
- Other notes: This defaults to Y.
Unchecked Value
- What it does: Value if the checkbox is not checked.
- How to use it: Enter the value.
- Other notes: This defaults to N.
Repeat Columns
- What it does: Number of columns in the list.
- How to use it: Enter the text.
- Other notes: This defaults to 0.
Repeat Direction
- What it does: Determines whether the options are listed horizontally or vertically.
- How to use it: Select from the drop down.
- Other notes: This defaults to Vertical.
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).
Load Type
- What it does: Determines how the system populates the checkbox list values.
- How to use it: Select from the drop down.
- Other notes: Options are:
- Code Group: The system populates the checkbox list with values from the codes value (this is most common).
- Query: The system executes a query to populate the checkbox list (this is second most common).
- Method: The system executes a method (local) to populate the checkbox list.
- Server Method: The system executes a server method to populate the checkbox list.
- Items: The system populates the checkbox list with manually entered values.
ServerMethod
- What it does: Method that comes from the remote object instead of the framework.
- How to use it: Enter the method.
- Other notes: The method has to be defined on the object before you can use it here.
Code Group
- What it does: Code table ID for the code ID-value pairing that populates the checkbox list.
- 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 checkbox list.
- 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 checkbox list.
- 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.
Plus icon
- What it does: Adds an item to the checkbox list.
- 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 checkbox list.
- How to use it: Select the item and click the icon.
- Other notes: This only displays if Load Type is Items.
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.)
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.)
Show Select All
- What it does: Displays a checkbox to select all the list items.
- How to use it: Click the checkbox to check or uncheck.
Select All Text
- What it does: Text that displays for the Show Select All option.
- How to use it: Enter the text.
Default Value
- What it does: Interacts with the Load Type to assign a value to the checkbox list.
- How to use it: Select from the drop down.
Display Count
- What it does: Allows limiting the number of list items to display.
- How to use it: Enter the count.
Display in Dialog
- What it does: Allows you to display the rest of the list items in a popup window, if the Display Count is configured.
- How to use it: Click the checkbox to check or uncheck.
Display Item Tooltip
- What it does: Allows you to display tooltips for the list items.
- How to use it: Click the checkbox to check or uncheck.
Display As List
- What it does: Displays the items in a list view.
- How to use it: Click the checkbox to check or uncheck.
Advanced Tab:
sfwItemToolTipField
- What it does: Represents the tooltip field to display tooltips for each item in the checkbox list.
- How to use it: Enter the text.
- Other notes: This property is available in the Custom panel. Make sure the query for the tooltip is added in the entity. Also, Load Type should be Query.
This post is part of multiple topics: