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 Retrieve_Click.
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 btnRetrieve_Click (Retrieve Button). It opens a popup lookup form. The user uses this form to search for a field value they don't know. They select a value from the search results and the linked field populates with that value.
Active Form
- What it does: ID of the lookup form the browser builds when the user clicks the button.
- How to use it: Enter the ID.
- Other notes: This always starts with wfm. It's the lookup form you want the button to open.
Related Control
- What it does: Identifies the grid the button affects.
- How to use it: Select from the drop down.
Lookup Message
- What it does: Message ID of the configured message from the framework's messages table (displays the predefined text message).
- How to use it: Enter the ID.
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).
ImageURL
- What it does: Relative address of the image you want to use for the button's icon.
- How to use it: Enter the relative URL.
- Other notes: This defaults to ~/Image/Lookup.jpg and is a magnifying glass icon. It comes from the Image folder in the .NET MVVM project.
Image Align
- What it does: Determines how the image is aligned in the cell.
- How to use it: Select an option from the list.
- Other notes: This defaults to AbsMiddle.
Selected Index
- What it does: Column that contains the value you want to populate the field.
- How to use it: Enter the text.
Retrieval Parameters
- What it does: Filters the search from the calling form.
- How to use it: Click the magnifying glass icon and add the control(s) to the parameter field(s).
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: