This document is archived and information here might be outdated.  Recommended version.


IToolbarPalette.Remove Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Controls)  

IToolbarPalette.Remove Method

Removes the item at the specified index from the ToolbarPalette.

[Visual Basic .NET]
Public Sub Remove ( _
    ByVal index As Integer _
)

[C#]
public void Remove (
    int index
);

[C++]
HRESULT Remove(
  long index
);

[C++]

Parameters
index [in]

  index is a parameter of type long

Product Availability

Available with ArcGIS Engine.

Description

Removes the item at the specified index from the ToolbarPalette. The item at the top of the palette as an index of 0.

Errors Returned

1023 800a03ff: The specified index is out of range

Remarks

The Remove method will automatically find the IToolbarItem::Command in the CommandPool and decrement the ICommandPool::UsageCount by 1. If the  ICommandPool::UsageCount reaches 0 the command will be released from the CommandPool.

See Also

IToolbarPalette Interface