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

BuildProcessCurrentFormat Property

This returns the current help file format being generated

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

Syntax

C++

Copy

public HelpFileFormats CurrentFormat { get; }

Public ReadOnly Property CurrentFormat As HelpFileFormats
	Get

public:
property HelpFileFormats CurrentFormat {
	HelpFileFormats get ();
}

member CurrentFormat : HelpFileFormats with get

Property Value

Type: HelpFileFormats

Remarks

The GenerateHelpFormatTableOfContents, GenerateHelpFileIndex, GenerateHelpProject, and CompilingHelpFile steps will run once for each help file format selected. This property allows a plug-in to determine which files it may need to work with during those steps or to skip processing if it is not relevant.

Reference

BuildProcess Class

SandcastleBuilder.Utils.BuildEngine Namespace