ComponentPlacement.ComponentPlacement Constructor

Definition

Namespace

Sandcastle.Core.BuildAssembler.BuildComponent

Assembly

Sandcastle.Core.dll

ComponentPlacement()

Default constructor

public ComponentPlacement()

Remarks

The Placement is set to None

ComponentPlacement(PlacementAction, string)

Constructor. Indicate the placement action and an optional component ID related to it if needed.

public ComponentPlacement(PlacementAction placement, string id)

Parameters

placement PlacementAction

The placement action to use

id string

A build component ID for use with the Before, After, or Replace Placement action.

Exceptions

ArgumentException

This is thrown if Before, After, or Replace is specified without an ID or if one is specified with None, Start, or End.

ComponentPlacement(PlacementAction, string, int)

Constructor. Indicate the placement action, component ID, and instance to act on.

public ComponentPlacement(PlacementAction placement, string id, int instance)

Parameters

placement PlacementAction

The placement action to use

id string

A build component ID for use with the Before, After, or Replace Placement action.

instance int

The instance to use with the placement option

Exceptions

ArgumentException

This is thrown if Before, After, or Replace is specified without an ID or if instance is less than one.