Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Component UI API supports navigation help content and F1 context help via a NavigationItemUIInterface.

Navigation based help allow allows you to associate help with a particular navigation hierarchy in the navigation tree. If you have registered a help item for a particular navigation item then when a user navigates to that location in the tree the framework will query you for help content for that item. F1 help allows you to supply help in your dialogs and panels that is displayed when the user presses F1.

...

To get help appearing in the help pane when the user navigates to an item in the navigation tree there are at least two things you need to do.

First, register a HELP help item with a Navigation Path that contains the path of the tree item. For instance, if the tree item was registered with the path NAVIGATIONTREE\ControlPanel\MyComponent  then the path you need to use for the main content of the help item is HELP\NAVIGATIONTREE\ControlPanel\MyComponent

Secondly, register child help items for each section of the help pane that you wish to place help content into.

e.g.

HELP\NAVIGATIONTREE\ControlPanel\MyComponent\Main

...