Help Attributes

Under Construction

See Also

Custom Delegates, Section Attributes, Form Section Fields, Canvas Section Advanced Controls, Advanced Canvas Control Custom Delegates, SHOWHELP()

Overview

Lianja provides a number of ways in which you can display help information for users:

• Help table
• Tooltips
• Info tips
• Context Menu

Help table

Help table: display help topic

A help table can be associated with one or more Apps. When a user clicks the Help icon in the section header, the HTML help topic associated with that section is displayed in a popup dialog.

Note: The help dialog can also be displayed using the SHOWHELP() function or the Lianja.showHelp() method.

Help table: Help Editor and new help table

The Help Editor is used to create help table content. It is accessed from its headerbar toolbutton.

If your App does not have a currently associated help table, you will be prompted to create it. If you click 'Yes', the table will be created automatically and added to the currently open database.

Help table: App Setting

The help table name - by default this is the name of your App followed by '_help' - will be automatically added to your App Settings.

If you want to use an existing help table instead of creating a new one, just specify its name in the Help table attribute in the App Settings.

Help table: new help topic

In the Help Editor, click the 'Add' button in the 'Help topics' panel and type in a unique help topic name.

Help table: create help text

Then, in the 'Help text' HTML editor, type the help contents to be displayed.

Help table: Help topic and Show help icon section attributes

Now open the Section Attributes dialog and in the Help topic attribute, specify the help topic name you created in the Help Editor.

Remember to check (True) the Show help icon attribute so that the help icon will be displayed in the section header.

Tooltips

Tooltip: display

When editing Form Section Fields or Canvas Section Advanced Controls, the Tooltip is displayed when the mouse hovers in the control.

Tooltip: attribute

The text to be displayed is specified in the Tooltip attribute.

Note: the text can contain HTML formatting.

Info tips

Info tips: display

Info tips also use the text from the Tooltip attribute.

Info tips differ from tooltips in that they are more prominently displayed and that they pop up immediately as you move between controls.

The display of info tips is toggled by the section header info tips icon.

Info tips: Show info tips icon section attribute

To display the info tips icon in the section header, the Show info tips icon section attribute must be checked (True).

Context Menu

Context Menu

Context Menu