C# Класс Axiom.Documentation.BuildProcess

Hooks into the DocProject build process for the project in which it's defined.

This class must be registered with the DocProject in the Active Projects tools options page in order for DocProject to instantiate it during a help build.

To cancel the build at any time call the BuildContext.Cancel method. The build process will end after the current step is executed, unless the step is being executed in the background. In that case, it may end immediately.

Note: Do not cache instances of the BuildContext class. A new BuildContext is created each time the project is built.

Наследование: BuildProcessComponent

Показать файл Открыть проект

Открытые методы

Метод	Описание
AfterExecuteStep ( IBuildStep step, BuildContext context ) : void	Called after a step has been executed during a help build.
BeforeExecuteStep ( IBuildStep step, BuildContext context ) : bool	Called before a step is executed during a help build.
BuildCompleted ( BuildContext context ) : void	Called after the project's help build has finished. The BuildContext.Cancel method has no affect at this point in the build process. This method is the final step before the build statistics are displayed. This method is always invoked if BuildStarting is invoked, regardless of whether an exception is thrown in any of the other methods, BuildContext.Cancel has been called, or an exeception has been thrown by the build engine. To determine whether a help build failed or succeeded, examine the value of the BuildContext.BuildState property.
BuildStarting ( BuildContext context ) : void	Called before the project's help build starts.

Описание методов

AfterExecuteStep() публичный метод

Called after a step has been executed during a help build.

public AfterExecuteStep ( IBuildStep step, BuildContext context ) : void
step	IBuildStep	implementation that was executed.
context	BuildContext	Provides information about the build process.
Результат	void

BeforeExecuteStep() публичный метод

Called before a step is executed during a help build.

public BeforeExecuteStep ( IBuildStep step, BuildContext context ) : bool
step	IBuildStep	implementation to be executed.
context	BuildContext	Provides information about the build process.
Результат	bool

BuildCompleted() публичный метод

Called after the project's help build has finished.

The BuildContext.Cancel method has no affect at this point in the build process. This method is the final step before the build statistics are displayed.

This method is always invoked if BuildStarting is invoked, regardless of whether an exception is thrown in any of the other methods, BuildContext.Cancel has been called, or an exeception has been thrown by the build engine.

To determine whether a help build failed or succeeded, examine the value of the BuildContext.BuildState property.

public BuildCompleted ( BuildContext context ) : void
context	BuildContext	Provides information about the build process.
Результат	void

BuildStarting() публичный метод

Called before the project's help build starts.

public BuildStarting ( BuildContext context ) : void
context	BuildContext	Provides information about the build process.
Результат	void