Help Icon on Dialog Pages

Another item I struggled with … adding the help icon to various dialogs (wizards, preferences, properties, about box, etc).

In almost all Eclipse dialogs … there is a question mark icon in the lower left hand corner. You click on this and it invokes the context sensitive help.

The problem was, I couldn’t figure out how to activate this.

I thought it would be controlled by some plug-in or product setting, but I couldn’t determine where.

After a fair bit of digging & debugging of base Eclipse, I determined that this feature is turned on globally for the entire application:

In the initialize() method of your WorkbenchAdvisor class, add the following:

TrayDialog.setDialogHelpAvailable(true);

As a side note, if you want to include Help from core Eclipse functions, just include the ‘org.eclipse.platform.doc.user’ plug-in.

Leave a Reply

Your email address will not be published. Required fields are marked *