Spread Windows Forms 6.0 Product Documentation
Remove Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > ExcelSparklineGroup Class : Remove Method


item
The object to remove from the ICollection.

Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Function Remove( _
   ByVal item As ISparkline _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As ExcelSparklineGroup
Dim item As ISparkline
Dim value As Boolean
 
value = instance.Remove(item)
C# 
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

ExceptionDescription
System.NotSupportedExceptionThe ICollection is read-only.

Example

This example creates and removes sparklines.
C#Copy Code
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.Win.Spread.ExcelSparkline es = new FarPoint.Win.Spread.ExcelSparkline(0, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5));
FarPoint.Win.Spread.ExcelSparkline es1 = new FarPoint.Win.Spread.ExcelSparkline(1, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(1, 0, 1, 5));
FarPoint.Win.Spread.ExcelSparkline es2 = new FarPoint.Win.Spread.ExcelSparkline(2, 6, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(2, 0, 1, 5));

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

esg.Add(es);
esg.Add(es1);
esg.Add(es2);
esg.Remove(es);
fpSpread1.Sheets[0].SparklineContainer.Add(esg);
Visual BasicCopy Code
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.Win.Spread.ExcelSparkline(0, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5))
Dim es1 As New FarPoint.Win.Spread.ExcelSparkline(1, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(1, 0, 1, 5))
Dim es2 As New FarPoint.Win.Spread.ExcelSparkline(2, 6, FpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(2, 0, 1, 5))

Dim esg As New FarPoint.Win.Spread.ExcelSparklineGroup(New FarPoint.Win.Spread.ExcelSparklineSetting(), FarPoint.Win.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 Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.