RhinoCommon API

LayerTablePurge Method (Int32, Boolean)

Deletes a layer and all geometry objects on a layer

Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public bool Purge(
	int layerIndex,
	bool quiet
)

Public Function Purge ( 
	layerIndex As Integer,
	quiet As Boolean
) As Boolean

layerIndex: Type: SystemInt32
zero based index of layer to delete. This must be in the range 0 <= layerIndex < LayerTable.Count.
quiet: Type: SystemBoolean
If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer.

Type: Boolean
true if successful. false if layerIndex is out of range or the the layer cannot be deleted because it is the current layer.

Version Information

Supported in: 5.4

Supported in: 6.8