GetExcelSetting Method

Gets the excel setting.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetExcelSetting() As ExcelSparklineSetting

'Usage
 
Dim instance As ExcelSparklineGroup
Dim value As ExcelSparklineSetting
 
value = instance.GetExcelSetting()

public ExcelSparklineSetting GetExcelSetting()

Example

This example creates sparklines.

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);
FarPoint.Win.Spread.ExcelSparklineSetting eSetting = new FarPoint.Win.Spread.ExcelSparklineSetting();
eSetting.ShowMarkers = true;
eSetting.AxisColor = Color.Cyan;
eSetting.DateAxis = true;
eSetting.DisplayEmptyCellsAs = FarPoint.Win.Spread.Chart.EmptyValueStyle.Gaps;
eSetting.DisplayHidden = true;
eSetting.DisplayXAxis = true;
eSetting.FirstMarkerColor = Color.AliceBlue;
eSetting.Formula = "Sheet1!$A$4:$E$4";
eSetting.HighMarkerColor = Color.Honeydew;
eSetting.LastMarkerColor = Color.Lavender;
eSetting.LineWeight = 2;
eSetting.LowMarkerColor = Color.LawnGreen;
eSetting.ManualMax = 3;
eSetting.ManualMin = 1;
eSetting.MarkersColor = Color.Magenta;
eSetting.MaxAxisType = FarPoint.Win.Spread.SparklineAxisMinMax.Custom;
eSetting.MinAxisType = FarPoint.Win.Spread.SparklineAxisMinMax.Individual;
eSetting.NegativeColor = Color.NavajoWhite;
eSetting.RightToLeft = true;
eSetting.SeriesColor = Color.SeaGreen;
eSetting.ShowFirst = true;
eSetting.ShowHigh = true;
eSetting.ShowLast = true;
eSetting.ShowLow = true;
eSetting.ShowNegative = true;
esg.Add(es);
esg.Add(es1);
esg.Add(es2);            
fpSpread1.Sheets[0].SparklineContainer.Add(esg);

FarPoint.Win.Spread.ExcelSparklineGroup ea = (FarPoint.Win.Spread.ExcelSparklineGroup)fpSpread1.ActiveSheet.SparklineContainer[0];
ea.Setting = eSetting;
FarPoint.Win.Spread.ExcelSparklineSetting getSetting = ea.GetExcelSetting();
FarPoint.Win.Spread.ExcelSparklineSetting expect = (FarPoint.Win.Spread.ExcelSparklineSetting)ea.Setting;
listBox1.Items.Add(eSetting.AxisColor.ToString());

Visual Basic

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)
FpSpread1.Sheets(0).SparklineContainer.Add(esg)

Dim eSetting As New FarPoint.Win.Spread.ExcelSparklineSetting()
eSetting.ShowMarkers = True
eSetting.AxisColor = Color.Cyan
eSetting.DateAxis = True
eSetting.DisplayEmptyCellsAs = FarPoint.Win.Spread.Chart.EmptyValueStyle.Gaps
eSetting.DisplayHidden = True
eSetting.DisplayXAxis = True
eSetting.FirstMarkerColor = Color.AliceBlue
eSetting.Formula = "Sheet1!$A$4:$E$4"
eSetting.HighMarkerColor = Color.Honeydew
eSetting.LastMarkerColor = Color.Lavender
eSetting.LineWeight = 2
eSetting.LowMarkerColor = Color.LawnGreen
eSetting.ManualMax = 3
eSetting.ManualMin = 1
eSetting.MarkersColor = Color.Magenta
eSetting.MaxAxisType = FarPoint.Win.Spread.SparklineAxisMinMax.[Custom]
eSetting.MinAxisType = FarPoint.Win.Spread.SparklineAxisMinMax.Individual
eSetting.NegativeColor = Color.NavajoWhite
eSetting.RightToLeft = True
eSetting.SeriesColor = Color.SeaGreen
eSetting.ShowFirst = True
eSetting.ShowHigh = True
eSetting.ShowLast = True
eSetting.ShowLow = True
eSetting.ShowNegative = True

Dim ea As FarPoint.Win.Spread.ExcelSparklineGroup = DirectCast(FpSpread1.ActiveSheet.SparklineContainer(0), FarPoint.Win.Spread.ExcelSparklineGroup)
ea.Setting = eSetting
Dim getSetting As FarPoint.Win.Spread.ExcelSparklineSetting = ea.GetExcelSetting()
Dim expect As FarPoint.Win.Spread.ExcelSparklineSetting = DirectCast(ea.Setting, FarPoint.Win.Spread.ExcelSparklineSetting)
ListBox1.Items.Add(eSetting.AxisColor.ToString())

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

ExcelSparklineGroup Class
ExcelSparklineGroup Members