ComponentPlacement Class

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

Definition

Namespace: Sandcastle.Core.BuildAssembler.BuildComponent
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
public class ComponentPlacement
Inheritance
Object    ComponentPlacement

Constructors

ComponentPlacement Default constructor
ComponentPlacement(PlacementAction, String) Constructor. Indicate the placement action and an optional component ID related to it if needed.
ComponentPlacement(PlacementAction, String, Int32) Constructor. Indicate the placement action, component ID, and instance to act on.

Properties

AdjustedInstance This property is used to get or set the instance of the component to replace, insert before, or insert after adjusted for other components that have already been processed.
Id This read-only property returns the ID of the component related to the PlacementAction if applicable.
Instance This read-only property returns the instance of the component to replace, insert before, or insert after.
Placement This read-only property returns the placement action value

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also