IBuildAssembler Interface

This interface defines the common Build Assembler tool properties, events, and methods used to generate help topics.

Definition

Namespace: Sandcastle.Core.BuildAssembler
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
C#View SourceRequest Example
public interface IBuildAssembler

Properties

BuildComponents This read-only property returns the current list of build components
Data This read-only property returns a dictionary that can be used to store information shared between build components.
TopicTransformation This read-only property returns the topic transformation to use for the presentation style
VerbosityLevel This read-only property returns the verbosity level for the message handlers

Methods

AddComponents Add a set of components based on the given configuration
ClearComponents Dispose of all components and clear them from the collection
LoadComponent This is used to create a component based on the given configuration
LoadComponents This is used to load a set of components in a configuration and return them as an enumerable list
OnComponentEvent This is used to raise the ComponentEvent
WriteMessage Write a component message to the message log

Events

ComponentEvent This event is raised when a component wants to signal that something of interest has happened

See Also