Table of Contents

Sandcastle.Core.BuildAssembler.BuildComponent Namespace

This namespace contains BuildAssembler component types.

Classes

AppliedChangesEventArgs

This is used by components to indicate that they have finished applying their changes to the given topic

ApplyingChangesEventArgs

This is used by components to indicate that they are about to apply their changes to the given document

BuildComponentConfiguration

This class is used to contain a build component's configuration and enabled state

BuildComponentCore

This is the abstract base class for all build components

BuildComponentExportAttribute

This is a custom version of the ExportAttribute that contains metadata for the BuildAssembler build components.

BuildComponentFactory

This is an abstract base class that defines the factory method for build components as well as build tool interaction methods.

ComponentConfigurationDictionary

This dictionary class is used to hold the third party build component configuration properties for a project such as the Code Block Component.

ComponentPlacement

This is used to define the placement of a build component within a BuildAssembler configuration file

CopyComponentCore

This abstract class is used to create copy components used in other build components such as CopyFromIndexComponent

CopyComponentExportAttribute

This is a custom version of the ExportAttribute that contains metadata for the BuildAssembler copy components.

FileCreatedEventArgs

This event arguments class is used by build components to indicate that they have saved a file of some sort (help content or fragment). The event handler is responsible for figuring out what to do with the event.

ProxyCredentials

This class is used to specify credentials for a proxy server.

UserCredentials

This class is used to specify user credentials.

Interfaces

IBuildComponentMetadata

This class defines the metadata for a BuildAssembler build component

ICopyComponentFactory

This interface defines the factory method for copy components

ICopyComponentMetadata

This class defines the metadata for a BuildAssembler build component

IMemberIdUrlResolver

This defines the interface used to resolve an API member ID to an online help website URL

Enums

PlacementAction

This enumeration defines the build component configuration file placement action values