| TocEntryToString Method (HelpFileFormats) |
Convert the table of contents entry and its children to a string
in the specified help file format.
Namespace: SandcastleBuilder.Utils.ConceptualContentAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax public string ToString(
HelpFileFormats format
)
Public Function ToString (
format As HelpFileFormats
) As String
public:
String^ ToString(
HelpFileFormats format
)
member ToString :
format : HelpFileFormats -> string
Parameters
- format
- Type: Sandcastle.CoreHelpFileFormats
The help file format to use
Return Value
Type:
StringThe entries in specified help format
Exceptions Exception | Condition |
---|
ArgumentException | This is thrown if the
format is not HtmlHelp1 or MSHelp2. |
See Also