Remove specified item from the this.dom

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 11.0.0.6296

Syntax

C#
public void removeItem(
	Item item
)
Visual Basic (Declaration)
Public Sub removeItem ( _
	item As Item _
)
J#
public void removeItem(
	Item item
)
JScript
public function removeItem(
	item : Item
)

Parameters

item
Type: Aras.IOM..::.Item
Item to be removed.

Remarks

this has to represent a collection of items. Passed item's dom must reference the same ArasXmlDocument as this.dom. If passed item's node is not null, the node and all its sub-items are removed from this.dom; else if passed item's nodeList is not null, every element of the list and its children are removed from this.dom. If before the removal either this.node or this.nodeList referenced any of the removed items, those properties are adjusted, i.e. this.node is set to null and\or this.nodeList is stripped of items that were just removed.

Exceptions

ExceptionCondition
System..::.ExceptionThe instance doesn't represent a collection of items.
System..::.ArgumentException
  • Passed item and this don't reference the same ArasXmlDocument.
  • Passed item has wrong internal strucure; e.g. both node and nodeList are null; etc.
  • Can't remove an item node as its parent node is read-only.

See Also