This class is a reimplementation of the MSHCComponent that allows the inclusion of a sortOrder attribute on the table of contents file elements. This allows the sort order of the elements to be defined to set the proper placement of the TOC entries when parented to an entry outside of the help file and to parent the API content within a conceptual content folder.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class MSHCComponent : BuildComponent
Visual Basic
Public Class MSHCComponent _
	Inherits BuildComponent

Remarks

The sortOrder attributes are optional. If not found, standard ordering is applied starting from zero. If a sortOrder attribute is found, numbering starts from that value for the associated topic and increments by one for all subsequent topics until another sortOrder attribute is encountered or the end of the group is reached.

Examples

CopyExample Component Configuration
<component type="SandcastleBuilder.Components.MSHCComponent"
  assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
  <data self-branded="{@SelfBranded}" topic-version="{@TopicVersion}" toc-file="toc.xml"
  toc-parent="{@ApiTocParentId}" toc-parent-version="{@TocParentVersion}" locale="{@Locale}" />
</component>
CopyExample toc.xml File
<?xml version="1.0" encoding="utf-8"?>
<topics>
  <!-- Sort our content below that of the parent node's existing sub-topics -->
  <topic id="d4648875-d41a-783b-d5f4-638df39ee413" file="d4648875-d41a-783b-d5f4-638df39ee413" sortOrder="100">
    <topic id="57f7aedc-17d3-4547-bdf9-5b468a08a1bc" file="57f7aedc-17d3-4547-bdf9-5b468a08a1bc" />
    <topic id="0e6bbd29-775a-8deb-c4f5-5b1e63349ef1" file="0e6bbd29-775a-8deb-c4f5-5b1e63349ef1" />
    <topic id="fcdfafc4-7625-f407-d8e9-ec006944e1d7" file="fcdfafc4-7625-f407-d8e9-ec006944e1d7" />
    <!-- API content (7 namespaces, merged later) goes here and this topic follows it -->
    <topic id="ce37cf86-fd95-49fc-b048-ba7d25d68d87" file="ce37cf86-fd95-49fc-b048-ba7d25d68d87" sortOrder="10">
  </topic>
  .
  .
  .
</topics>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    SandcastleBuilder.Components..::..MSHCComponent

See Also