WizardPage.ShowHelp Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, provides a mechanism to display the wizard Help file.
protected public:
virtual void ShowHelp();protected internal virtual void ShowHelp ();abstract member ShowHelp : unit -> unit
override this.ShowHelp : unit -> unitProtected Friend Overridable Sub ShowHelp ()Examples
The following example demonstrates the ShowHelp method. In this example, the ShowHelp method checks the value of the CanShowHelp property to determine whether the Help file can be displayed. If CanShowHelp is true, the Help file is displayed. This code example is part of a larger example provided for the WizardPage class.
// Customize the CanShowHelp method.
public new bool CanShowHelp
{
get
{
return true;
}
}
// Customize the ShowHelp method.
public new void ShowHelp()
{
// Check to determine if the CanShowHelp will
// allow help to be shown.
if (CanShowHelp)
{
// Show the help file.
Help.ShowHelp(this, "D:/minint/Microsoft.NET/framework/1033/admin.chm");
// Alternatively, use the folllowing to navigate to Tech Net.
//Help.ShowHelp(null, "http://www.technet.com");
}
}
Remarks
You must override this method to enable the display of the Help file. The base class method throws a System.NotImplementedException. Implementers should call this method to display the contents of the Help file or a hyperlink to the specified URL. Implementers should check the CanShowHelp property to determine whether the user can view Help.
This method enables you to create a custom ShowHelp method.