CompoundStructure.DeleteLayer

Public Class

Deletes the specified layer from this CompoundStructure.

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public bool DeleteLayer(
  int layerIdx
)

Parameters

layerIdxInt32

The layer index is zero based. It counts from the exterior of wall and from the top of roofs, floors and ceilings.

Return Value

Boolean
True if the layer was successfully deleted, and false otherwise.

Exceptions

Exception

Condition

ArgumentException

The layer cannot be deleted.

ArgumentOutOfRangeException

The layer index is out of range.

Remarks

For a vertically compound structure, a layer may only be deleted if it is not associated to a region, or else it is associated to exactly one simple region, which will also be deleted. Regions associated to layers with index greater than layerIdx will have their associated layer indices decremented by one.