SparklineCollection.Remove(Sparkline) Method

Removes the specified sparkline from the collection.

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

C#
VB.NET

csharp

bool Remove(
    Sparkline item
)

Function Remove(
    item As Sparkline
) As Boolean

Parameters

Name	Type	Description
item	Sparkline

A Sparkline object to be removed from the collection.

Returns

Type	Description
Boolean

true , if the specified sparkline contained in the collection was successfully removed; otherwise, false

Remarks

All sparklines in a worksheet are organized in groups. Each sparkline group includes one or more sparklines stored within the SparklineCollection collection, accessible using the SparklineGroup.Sparklines property. Use the collection’s Remove method to remove the existing sparkline from the sparkline group.

You can also remove a sparkline at the specified index in the collection by using the SparklineCollection.RemoveAt method. To remove the entire sparkline group, use the SparklineGroupCollection.Remove, SparklineGroupCollection.RemoveAt or SparklineGroup.Delete method.

To add a new sparkline to the existing sparkline group, use the SparklineCollection.Add method.