Utility.ShowHelpTopic Method

UtilityShowHelpTopic Method

Show a help topic in the SHFB help file

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public static void ShowHelpTopic(
	string topic
)

Public Shared Sub ShowHelpTopic ( 
	topic As String
)

public:
static void ShowHelpTopic(
	String^ topic
)

static member ShowHelpTopic : 
        topic : string -> unit

Parameters

topic: Type: SystemString
The topic ID to display (will be formatted as "html/[Topic_ID].htm")

Remarks

Since the standalone GUI already has a Help 1 file, we'll just display the topic that it contains rather than integrating an MSHC help file into the VS 2010 collection.

Reference

Utility Class

SandcastleBuilder.Utils Namespace