Sandcastle Help File Builder Documentation
Sandcastle
This namespace contains the classes used to load and manage third-party build components that can be used with the help file builder and Sandcastle tools (plug-ins, build components, syntax generators, and presentation styles).
Classes
| BuildComponentConfiguration | This class is used to contain a build component's configuration and enabled state |
| ComponentConfigurationDictionary | This dictionary class is used to hold the third party build component configuration properties for a project such as the Code Block Component. |
| ExecutionContext | This class defines the execution context in which the plug-in is being called during the build process |
| ExecutionPoint | This class defines when a plug-in gets executed during the build process |
| HelpFileBuilderPlugInExportAttribute | This is a custom version of the ExportAttribute that contains metadata for the help file builder plug-ins. |
| PlugInConfiguration | This class is used to contain a plug-in's configuration and enabled state |
| PlugInConfigurationDictionary | This dictionary class is used to hold the configurations for third party build process plug-ins such as the Additional Content Only plug-in. |
| PlugInConfigurationEditorExportAttribute | This is a custom version of the ExportAttribute that contains metadata for the help file builder plug-in configuration editors. |
| ProxyCredentials | This class is used to specify credentials for a proxy server. |
| UserCredentials | This class is used to specify user credentials. |
Interfaces
| IPlugIn | This interface defines the methods required to implement a Sandcastle Help File Builder build process plug-in. |
| IPlugInConfigurationEditor | This class defines the interface used to edit a plug-in configuration |
| IPlugInConfigurationEditorMetadata | This class defines the metadata for a plug-in configuration editor |
| IPlugInMetadata | This class defines the metadata for a Sandcastle Help File Builder build process plug-in |
Enumerations
| ExecutionBehaviors | This public enumerated type defines the execution behavior of a build process plug-in |