HelpTopicInfo Constructor (String, String)

 

Initializes a new instance of the HelpTopicInfo class with a path to the help file and a topic ID.

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

Syntax

public HelpTopicInfo(
    string helpFilePath,
    string topicId
)

public:
HelpTopicInfo(
    String^ helpFilePath,
    String^ topicId
)

Public Sub New (
    helpFilePath As String,
    topicId As String
)

Parameters

• helpFilePath
  Type: System.String

  The path to the help file.

• topicId
  Type: System.String

  The topic ID within the help file.

Remarks

A HelpTopicInfo object is used to add help information to a page in the Dashboard. The HelpTopicInfo object is initialized and returned by the CreateHelpTopicInfo method.

Examples

The following code example shows how to use the HelpTopicInfo object to provide help information for a page:

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

    return helpTopic;
}

See Also

HelpTopicInfo Overload
HelpTopicInfo Class
Microsoft.WindowsServerSolutions.Administration.ObjectModel Namespace

Return to top