Total .NET Analyzer Rule Documentation  

FormHelpButton Rule

Consider setting the form's HelpButton property to True.

Remarks

Windows forms should provide adequate context-sensitive help information on all forms with any reasonable amount of functionality (i.e. forms other than the Splash Screen, the About Box, etc.). A standard way of providing this help information is through the question mark button in the Control Box.

Resolution

Set the form's HelpButton property to True through the Windows Form Designer Properties window, and a small button with a question mark appears in the caption bar to the left of the close button. After adding this button to your form, create an event handler for the HelpRequested event to display information when the user clicks the button.

See Also

Form.HelpButton Property

Control.HelpRequested Event