DetailItemCollection.Remove Method

DetailItemCollection Remove Method

TIBCO Spotfire 6.0 API Reference

Removes the specified item from the collection.

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public bool Remove(
	DetailItem item
)

public bool Remove(
	DetailItem item
)

Parameters

item: Type: Spotfire.Dxp.Application.Visuals DetailItem
The item.

Return Value

Type: Boolean
True if the item was succesfully removed. False if the item could not be removed or if it could not be found in the collection

Remarks

Only user defined items (ExpressionDetailItem) can bed added and removed. The default items supplied by the owning plot cannot be removed, and hence return false.