ControlRendererPage.CreateHelpTopicInfo Method ()

 

Initializes a new instance of the HelpTopicInfo class that provides help information for the page in the Dashboard.

Namespace:   Microsoft.WindowsServerSolutions.Administration.ObjectModel
Assembly:  Microsoft.WindowsServerSolutions.Administration.ObjectModel (in Microsoft.WindowsServerSolutions.Administration.ObjectModel.dll)

Syntax

protected virtual HelpTopicInfo CreateHelpTopicInfo()

protected:
virtual HelpTopicInfo^ CreateHelpTopicInfo()

Protected Overridable Function CreateHelpTopicInfo As HelpTopicInfo

Return Value

Type: Microsoft.WindowsServerSolutions.Administration.ObjectModel.HelpTopicInfo

An instance of HelpTopicInfo.

Remarks

This method must be overridden in a user-defined class.

Examples

The following code example shows how to initialize a new Page in a user-defined class and override the CreateHelpTopicInfo method:

class AddinSample : Page
{
    public AddinSample() : base(new Guid("6bee53dd-4eb8-4aeb-98a1-7af77a8bb449"), "DisplayName", "Description")
    {
    }

    protected override PageContent CreateContent()
    {
        return PageContent.Create<TBusinessObject>(
            listProvider,
            listColumns,
            listGroupings,
            tasks);
    }

    protected override HelpTopicInfo CreateHelpTopicInfo()
    {
        HelpTopicInfo helpTopic = null;
        helpTopic = new HelpTopicInfo(@"<path to help .chm file>",
            @"/html/076d08c2.html");

        return helpTopic;
    }
}

See Also

ControlRendererPage Class
Microsoft.WindowsServerSolutions.Administration.ObjectModel Namespace

Return to top