Remove Method (ExcelSparklineGroup)

Removes the first occurrence of a specific object from the ICollection.

Syntax

Visual Basic
C#

'Declaration
 
Public Function Remove( _
   ByVal item As ISparkline _
) As Boolean

'Usage
 
Dim instance As ExcelSparklineGroup
Dim item As ISparkline
Dim value As Boolean
 
value = instance.Remove(item)

public bool Remove( 
   ISparkline item
)

Parameters

item: The object to remove from the ICollection.

Return Value

true if item was successfully removed from the ICollection; otherwise, false. This method also returns false if item is not found in the original ICollection.

Exceptions

Exception	Description
System.NotSupportedException	The ICollection is read-only.

Example

This example creates a sparkline in a cell.

fpSpread1.Sheets[0].RowCount = 10;
fpSpread1.Sheets[0].ColumnCount = 10;

fpSpread1.Sheets[0].SetClip(0, 0, 1, 5, "1\t2\t3\t4\t5");
fpSpread1.Sheets[0].SetClip(1, 0, 1, 5, "5\t4\t3\t2\t1");
fpSpread1.Sheets[0].SetClip(2, 0, 1, 5, "1\t2\t3\t2\t1");

FarPoint.Web.Spread.ExcelSparkline es = new FarPoint.Web.Spread.ExcelSparkline(0, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(0, 0, 1, 5));
FarPoint.Web.Spread.ExcelSparkline es1 = new FarPoint.Web.Spread.ExcelSparkline(1, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(1, 0, 1, 5));
FarPoint.Web.Spread.ExcelSparkline es2 = new FarPoint.Web.Spread.ExcelSparkline(2, 6, fpSpread1.Sheets[0], new FarPoint.Web.Spread.Model.CellRange(2, 0, 1, 5));

FarPoint.Web.Spread.ExcelSparklineGroup esg = new FarPoint.Web.Spread.ExcelSparklineGroup(new FarPoint.Web.Spread.ExcelSparklineSetting(), FarPoint.Web.Spread.SparklineType.Column);

esg.Add(es);
esg.Add(es1);
esg.Add(es2);
esg.Remove(es);
fpSpread1.Sheets[0].SparklineContainer.Add(esg);

Visual Basic

FpSpread1.Sheets(0).RowCount = 10
FpSpread1.Sheets(0).ColumnCount = 10
FpSpread1.Sheets(0).SetClip(0, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "4" + Chr(9) + "5")
FpSpread1.Sheets(0).SetClip(1, 0, 1, 5, "5" + Chr(9) + "4" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")
FpSpread1.Sheets(0).SetClip(2, 0, 1, 5, "1" + Chr(9) + "2" + Chr(9) + "3" + Chr(9) + "2" + Chr(9) + "1")

Dim es As New FarPoint.Web.Spread.ExcelSparkline(0, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(0, 0, 1, 5))
Dim es1 As New FarPoint.Web.Spread.ExcelSparkline(1, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(1, 0, 1, 5))
Dim es2 As New FarPoint.Web.Spread.ExcelSparkline(2, 6, FpSpread1.Sheets(0), New FarPoint.Web.Spread.Model.CellRange(2, 0, 1, 5))

Dim esg As New FarPoint.Web.Spread.ExcelSparklineGroup(New FarPoint.Web.Spread.ExcelSparklineSetting(), FarPoint.Web.Spread.SparklineType.Column)

esg.Add(es)
esg.Add(es1)
esg.Add(es2)
esg.Remove(es)
FpSpread1.Sheets(0).SparklineContainer.Add(esg)

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

ExcelSparklineGroup Class
ExcelSparklineGroup Members