Page.CreateHelpTopicInfo Method

Article
09/17/2008

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

Namespace: Microsoft.EssentialBusinessServer.Console.ObjectModel
Assembly: Microsoft.EssentialBusinessServer.Console.ObjectModel (in microsoft.essentialbusinessserver.console.objectmodel.dll)

Usage

Syntax

'Declaration
Protected Overridable Function CreateHelpTopicInfo As HelpTopicInfo

protected virtual HelpTopicInfo CreateHelpTopicInfo ()

protected:
virtual HelpTopicInfo^ CreateHelpTopicInfo ()

protected HelpTopicInfo CreateHelpTopicInfo ()

protected function CreateHelpTopicInfo () : HelpTopicInfo

Return Value

An instance of HelpTopicInfo.

Example

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;
    }
}

Remarks

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008 64-bit Edition, Windows Vista 64-bit Edition, Windows Essential Business Server 2008 Standard, Windows Essential Business Server 2008 Premium

Target Platforms

Windows Essential Business Server 2008 Standard, Windows Essential Business Server 2008 Premium

Share via