GetSparkline(Int32,Int32,ISparklineGroup,ISparkline) Method

Gets the sparkline in the specified location.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetSparkline( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByRef sparklineGroup As ISparklineGroup, _
   ByRef sparkline As ISparkline _
) As Boolean

'Usage
 
Dim instance As DefaultSparklineContainer
Dim row As Integer
Dim column As Integer
Dim sparklineGroup As ISparklineGroup
Dim sparkline As ISparkline
Dim value As Boolean
 
value = instance.GetSparkline(row, column, sparklineGroup, sparkline)

public bool GetSparkline( 
   int row,
   int column,
   out ISparklineGroup sparklineGroup,
   out ISparkline sparkline
)

Parameters

row: The row.
column: The column.
sparklineGroup: The sparkline group information in the specified location.
sparkline: The sparkline.

Return Value

true if the sparkline exists in the location.

Example

This example uses the GetSparkline method.

fpSpread1.Sheets[0].SetClip(0, 0, 1, 5, "1\t2\t3\t4\t5");
FarPoint.Win.Spread.ExcelSparklineSetting eSetting = new FarPoint.Win.Spread.ExcelSparklineSetting();
eSetting.ShowMarkers = true;
eSetting.AxisColor = Color.Cyan;
FarPoint.Win.Spread.ExcelSparkline es = new FarPoint.Win.Spread.ExcelSparkline(0, 5, fpSpread1.Sheets[0], new FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5));
FarPoint.Win.Spread.ExcelSparklineSetting est = eSetting;
FarPoint.Win.Spread.ExcelSparklineGroup esg = new FarPoint.Win.Spread.ExcelSparklineGroup(est, FarPoint.Win.Spread.SparklineType.Column);
esg.Add(es);
fpSpread1.Sheets[0].SparklineContainer.Add(esg);
FarPoint.Win.Spread.ISparklineGroup outGroup;
FarPoint.Win.Spread.ISparkline outSL;
fpSpread1.Sheets[0].SparklineContainer.GetSparkline(1, 5, out outGroup, out outSL);

Visual Basic

fpSpread1.Sheets(0).SetClip(0, 0, 1, 5, "1" & vbTab & "2" & vbTab & "3" & vbTab & "4" & vbTab & "5")
Dim eSetting As New FarPoint.Win.Spread.ExcelSparklineSetting()
eSetting.ShowMarkers = True
eSetting.AxisColor = Color.Cyan
Dim es As New FarPoint.Win.Spread.ExcelSparkline(0, 5, fpSpread1.Sheets(0), New FarPoint.Win.Spread.Model.CellRange(0, 0, 1, 5))
Dim est As FarPoint.Win.Spread.ExcelSparklineSetting = eSetting
Dim esg As New FarPoint.Win.Spread.ExcelSparklineGroup(est, FarPoint.Win.Spread.SparklineType.Column)
esg.Add(es)
fpSpread1.Sheets(0).SparklineContainer.Add(esg)
Dim outGroup As FarPoint.Win.Spread.ISparklineGroup
Dim outSL As FarPoint.Win.Spread.ISparkline

fpSpread1.Sheets(0).SparklineContainer.GetSparkline(1, 5, outGroup, outSL)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

DefaultSparklineContainer Class
DefaultSparklineContainer Members
Overload List