Remove Method (IUIHierarchyNodeList)

Removes the first occurrence of an IUIHierarchyNode within the list.

Syntax

Visual Basic

'Declaration
 
Sub Remove( _
   ByVal node As IUIHierarchyNode _
) 

C#

void Remove( 
   IUIHierarchyNode node
)

Parameters

node

The node being removed from the list.

Exceptions

Exception	Description
System.NotSupportedException	Thrown when either of the IsReadOnly or IsFixedSize properties return True.

Remarks

The IUIHierarchyNodeList is comprised of contiguous elements causing the IUIHierarchyNode instances following the removed node to move up one space filling-in the vacancy. Applications retaining indexes to nodes later in the list must refresh (or invalidate) these indexes following one or more removal operations.

Implementations of IUIHierarchyNode that require the Remove method to function based on a node's value equivalency must override Equals and GetHashCode when their class implements IUIHierarchyNode, otherwise the node must be reference identical to an IUIHierarchyNode within the list for it to be removed.

When node cannot be located within the list, this method has no effect.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2