Element.DeleteSubelement

Public Class

Removes a subelement from the element.

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

Syntax

public bool DeleteSubelement(
  Subelement subelem
)

Parameters

subelem Subelement

The subelement to delete.

Return Value

Boolean
True if entire element was deleted, false otherwise.

Exceptions

Exception

Condition

ArgumentException

The subelement subelem does not exist in the element. -or- Subelement subelem cannot be deleted.

ArgumentNullException

A non-optional argument was null

ModificationForbiddenException

This Element is an internal element, such as a component of a loaded family or a group type. -or- The document containing this Element is in Group Edit Mode, Sketch Edit Mode, or Paste Mode, and the element is not a member of the group, sketch, or clipboard. -or- This Element is a member of a group or sketch, and the document is not currently editing the group or sketch.

Remarks

Depending on implementation for given element as the result, the element can be deleted - especially if after subelement deletion there are no subelements left. See also: IsModifiable.