Table of Contents

IBuildProcess.CurrentFormat Property

Definition

Namespace
Sandcastle.Core.BuildEngine
Assembly
Sandcastle.Core.dll

This read-only property is used to get the current help file format being generated

HelpFileFormats CurrentFormat { get; }

Property Value

HelpFileFormats

Remarks

The 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.