Context Specific Help
It is possible to add context-specific client help to many different areas of dbFront including:
This topic is going to explain how you can add context-specific help to a record. This context-specific help that can automatically change depending upon the contents of the record. In the example below, we are going to look at adding help that is specific to a record's status. You could extend this example to make the help date specific.
Step 1. Getting the Help Text
The first step would be to store the "Status" specific help somewhere in your database and create a view to retrieve it.
Below is a sample SalesOrderStatus table with a HelpText column. The idea is that different help text is displayed depending upon the status of a given SalesOrder. You can get as creative as you need, you can even include date-specific help if needed. The only requirement is that you are able to make a view that can retrieve the HelpText for that SalesOrder.
The following relationship is not required to retrieve the HelpText but is handy if you want a dropdown in dbFront.
Here is a sample view that returns the HelpText for the current StatusId. This view will be joined to the table in dbFront so you may want to look at the following help topic for more details: Table Views.
Step 2. Displaying and Formatting the Help.
Once you can retrieve the HelpText, you would make the following changes in dbFront to display and layout the help.
- Open the table properties in dbFront.
- Switch to the "Views" tab and select the "vSalesOrderStatusHelp" view you just created,
- Save the table properties and open them again,
- Open the "Form Fields" tab and add the view field "vStatusHelpText" to the top of your selected field list,
- Save the table properties again.
This should now show the HelpText for that record's StatusId in a read-only field at the top of the display.
Now we format the Help Text further.
- Open the Help Text field properties.
- Change the Caption to the help text you would want to see if a "New" record was on screen. e.g. "Save this record to continue processing."
- Switch to the "Layout" tab.
- Change the Label Position to "Inline"
- Optionally set a Css Class name for the Help Text
- Save your changes.
The "inline" Label Position will cause the HelpText to display full width with the caption hidden. If no record or an empty HelpText is selected then the user will see the Caption you specified for the Help Text.
You can add a custom CSS file to further format the help text based on the CSS Class you assigned in the last step.