BuildProcess.DefaultTopicFile 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

BuildProcessDefaultTopicFile Property

This returns the filename of the default topic as determined by the build engine

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

Syntax

C++

Copy

public string DefaultTopicFile { get; }

Public ReadOnly Property DefaultTopicFile As String
	Get

public:
property String^ DefaultTopicFile {
	String^ get ();
}

member DefaultTopicFile : string with get

Property Value

Type: String

Remarks

The path is relative to the root of the output folder (i.e. html/DefaultTopic.htm)

Reference

BuildProcess Class

SandcastleBuilder.Utils.BuildEngine Namespace