BuildProcess.ApiTocOrder Property

Sandcastle Help File Builder Documentation

SandcastleBuilder.Utils Namespaces

SandcastleBuilder.Utils.BuildEngine

BuildProcess Class

BuildProcess Properties

ApiTocOrder Property

ApiTocParentId Property

BuildApiFilter Property

BuildCanceled Property

CommentsFiles Property

ConceptualContent Property

CurrentFormat Property

CurrentProject Property

DefaultTopicFile Property

FrameworkSettings Property

Help1CompilerFolder Property

Help1Files Property

Help2CompilerFolder Property

Help2Files Property

HelpFormatOutputFolders Property

HelpViewerFiles Property

LoadedPlugIns Property

LogFilename Property

MSBuildExePath Property

OpenXmlFiles Property

OutputFolder Property

PartialBuildType Property

PresentationStyle Property

PresentationStyleFolder Property

PresentationStyleResourceItemsFolder Property

ProjectFilename Property

ProjectFolder Property

ReferencedNamespaces Property

ReflectionInfoFilename Property

ResolvedHelpTitle Property

ResolvedHtmlHelpName Property

RootContentContainerId Property

SuppressApiFilter Property

TemplateFolder Property

WebsiteFiles Property

WorkingFolder Property

BuildProcessApiTocOrder Property

This is used to get or set the sort order for API content so that it appears within its parent in the correct position.

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

Syntax

C++

Copy

public int ApiTocOrder { get; set; }

Public Property ApiTocOrder As Integer
	Get
	Set

public:
property int ApiTocOrder {
	int get ();
	void set (int value);
}

member ApiTocOrder : int with get, set

Property Value

Type: Int32

Remarks

The default is -1 to let the build engine determine the best value to use based on the other project properties.

Reference

BuildProcess Class

SandcastleBuilder.Utils.BuildEngine Namespace