Interface IChartLegendEntries

Represents a collection of legend entries in the chart.

Namespace: Syncfusion.XlsIO
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public interface IChartLegendEntries

Properties

Count

Gets the number of legend entries in the collection. Read-only.

Declaration
int Count { get; }
Property Value
Type
System.Int32
Remarks

To know more about charts refer this link.

Examples

The following code illustrates use of LegendEntries Count property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //Gets the count of legend entries.
        int legendEntriesCount = chart.Legend.LegendEntries.Count;
        if (legendEntriesCount != 0)
        {
            //Your code here
        }    

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

Item[Int32]

Gets the legend entry with the specified index. Read-only.

Declaration
IChartLegendEntry this[int iIndex] { get; }
Parameters
Type Name Description
System.Int32 iIndex
Property Value
Type
IChartLegendEntry
Remarks

To know more about charts refer this link.

Examples

The following code illustrates use of iIndex property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //Create a chartLegend
        IChartLegend chartLegend = chart.Legend;
        chartLegend.LegendEntries[1].TextArea.Color = ExcelKnownColors.Blue_grey;
        chartLegend.LegendEntries[1].TextArea.Size = 10;
        chartLegend.LegendEntries[1].TextArea.FontName = "Bernard MT Condensed";

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

Extension Methods