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 not necessary for this control.
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: Rule that determines whether the control is visible.
- How to use it: Enter the rule or select from the list.
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: Select among formats for date, currency, percent, or SSN.
Related Control
- What it does: The control whose method executes when the user clicks the value if the column is linkable.
- How to use it: Select from the list of available controls.
Entity Field
- What it does: Entity and column the value comes from.
- How to use it: Enter the entity and column.
Text
- What it does: Text of the label.
- How to use it: Enter the text.
Width
- What it does: Pixel width of the label.
- How to use it: Enter the number of pixels.
- Other notes: This defaults based on the amount of text and the dimensions of the cell.
Skin ID
- What it does: Controls the text formatting.
- How to use it: Select the skin from the drop down.
- Other notes: Available selections are blank (default formatting), ReqInformation (for *), and WhiteText.
Balloon Tooltip Hyperlink
- What it does: Hyperlink to display when the user rolls over the label.
- How to use it: Enter the URL.
Balloon Tooltip
- What it does: Text to display when the user rolls over the label.
- How to use it: Enter the text.
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).
Linkable checkbox
- What it does: Turns the value into a hyperlink.
- How to use it: Click to check or uncheck the checkbox.
- Other notes: If this is checked, you must set the Related Control.
Render Type
- What it does: Determines how the system populates the control value.
- How to use it: Select from the drop down.
- Other notes: Options are:
- None: This is the default rendering option.
- RichText: Renders the control in an HTML text editor that allows you to format the text.
- Rating: Allows you to display ratings in the form of solid stars out of outlined stars. This control requires further configurations.
- NumSpinner: Allows you to increment or decrement the control value using a + (plus) and - (minus) icon. The min and max value can be configured from this control.
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.
Header Text
- What it does: Text of the column heading.
- How to use it: Enter the text.
Sort Expression
- What it does: Table column that contains the value the grid column expresses.
- How to use it: Enter the column.
- Other notes: Automatically populates if you added the control from the entity attributes.
Item Alignment
- What it does: Alignment of the column value within the column.
- How to use it: Select from the available alignments.
- Other notes: Default NotSet, which is left aligned.
Header Alignment
- What it does: Alignment of the column header.
- How to use it: Select from the available alignments.
- Other notes: Default NotSet, which is left aligned.
Footer Alignment
- What it does: Alignment of the column footer.
- How to use it: Select from the available alignments.
- Other notes: Default NotSet, which is left aligned.
Header Group Name
- What it does: Specifies the group name for the headers.
- How to use it: Enter the text.
Show in ExportToExcel checkbox
- What it does: Determines the flag to show the column in Export to Excel when Visibility is set to False.
- How to use it: Click to check or uncheck the checkbox.
Set Footer button
- What it does: Allows the developer to perform basic operations on the column values (like Sum, Min, Max, etc.
- How to use it:
- Click the button.
- Select Is MVVM checkbox.
- Select the operation you want to perform.
- Enter the Caption.
- Click OK.
Cell Format button
- What it does: Changes the appearance of the cell containing a specific value.
- How to use it:
- Click the button.
- Select the column that contains the value you want to determine the cell's appearance.
- Click the plus icon to add a condition.
- Enter the value you want to change the cell's appearance.
- Enter the CSS class you want that cell to change to.
- Repeat steps 3-5 as many times as desired.
- Other notes: The CSS class must already be configured in the style sheet.
Advanced Tab:
Tooltip
- What it does: Displays a tooltip in HTML or simple format.
- How to use it: Enter the text.
- Other notes: Any entity fields included in the tooltip need to be enclosed in curly braces. Example: {FirstName}.
This post is part of multiple topics: