Back to Devexpress

SparklineCollection.Remove(Sparkline) Method

officefileapi-devexpress-dot-spreadsheet-dot-sparklinecollection-dot-remove-x28-devexpress-dot-spreadsheet-dot-sparkline-x29.md

latest2.9 KB
Original Source

SparklineCollection.Remove(Sparkline) Method

Removes the specified sparkline from the collection.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
bool Remove(
    Sparkline item
)
vb
Function Remove(
    item As Sparkline
) As Boolean

Parameters

NameTypeDescription
itemSparkline

A Sparkline object to be removed from the collection.

|

Returns

TypeDescription
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.

See Also

RemoveAt(Int32)

Spreadsheet Document API Examples

SparklineCollection Interface

SparklineCollection Members

DevExpress.Spreadsheet Namespace