Component Placement 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: 2026.1.20.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public class ComponentPlacementVB
Public Class ComponentPlacementC++
public ref class ComponentPlacementF#
type ComponentPlacement = class end- 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
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |