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 btn.
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: Allows the user access to the control if it evaluates to true. Disables (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.
Text
- What it does: Text the user sees on the button; what the button is "called".
- How to use it: Enter the text.
- Other notes: This defaults to New.
Method Type
- What it does: Method that executes when the user clicks the button.
- How to use it: This property is read-only.
- Other notes: This defaults to btnNew_Click (Create New Record). It does the following:
- Creates a new instance of the business object and sets the default values.
- Binds the values from the form object to the maintenance form controls.
- Applies the new page mode plus read-only and visibility rules.
- Stores the form object in the metadata cache.
- Sends everything the browser needs to build the active form.
On Client Click
- What it does: Displays a message when the user clicks the button.
- How to use it: Select a message from the drop down.
Related Control
- What it does: Identifies the grid the button affects.
- How to use it: Select from the drop down.
Active Form
- What it does: Form the button navigates to when clicked.
- How to use it: Enter the form.
- Other notes: The form has to exist as an XML file before you can enter it.
Single Active Form radio button
- What it does: Allows one active form to navigate to.
- How to use it: Select the radio button.
Multiple Active Form radio button
- What it does: Allows multiple active forms to navigate to.
- How to use it: Select the radio button.
Security Level
- What it does: Determines the security level of the button.
- How to use it: Select the desired security level.
- Other notes: This defaults to None. Other options are Read, Modify, New, Delete, or Execute.
Check Changes checkbox
- What it does: If checked, checks for changes in the data before executing the method.
- How to use it: Click to check or uncheck.
Navigation Parameter
- What it does: If the method takes a parameter(s), this property maps that parameter(s) to the column value(s).
- How to use it: Click the magnifying glass to open the Navigation Parameter window. Drag the matching form control to the Parameter Value field. If the parameter's value is assigned by the application (it is a primary key), mark it constant.
- Other notes: A custom new method (configured on the entity) usually takes at least one parameter. The new object method from the framework usually does not. Exception: if the form has session fields (carry criteria), these must be mapped in the navigation parameters.
User Log Parameters
- What it does: Specifies the control values that need to be logged.
- How to use it: Click the magnifying glass icon and add the control(s) to the parameter field(s).
Grid Toolbar Button checkbox
- What it does: If checked, displays icons instead of buttons on the forms.
- How to use it: Click to check or uncheck the checkbox.
No Row Selected
- What it does: Message that displays when the user clicks the button without selecting any record.
- How to use it: Select from the drop down.
Advanced Tab:
sfwOpenInDialog
- What it does: Opens the active form in a popup window.
- How to use it: Select from the drop down.
This post is part of multiple topics: