IChartLegendEntry Interface |
Represents a legend entry in a chart legend.
Namespace: Spire.Xls.Core
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
The IChartLegendEntry type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
BackgroundMode |
Display mode of the background.
|
|
IsDeleted |
If true then this entry deleted. otherwise false.
Examples
The following code illustrates use of IsDeleted property:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Cone3DClustered;</para><para>//Create a chartLegend</para><para>IChartLegend chartLegend = chart.Legend;</para><para>chartLegend.LegendEntries[0].Delete();</para><para>//True if the entry is deleted</para><para>bool isDeletedEntry = chartLegend.LegendEntries[0].IsDeleted;</para><para>if(isDeletedEntry){ //Your code here }</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
|
|
|
IsFormatted |
True if the legend entry has been formatted.
Examples
The following code illustrates use of IsFormatted property:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Cone3DClustered;</para><para>//Create a chartLegend</para><para>IChartLegend chartLegend = chart.Legend;</para><para>chartLegend.LegendEntries[1].TextArea.Color = Color.Blue;</para><para>//True if the legend entry is formatted</para><para>bool isEntryFromatted = chartLegend.LegendEntries[1].IsFormatted;</para><para>if(isEntryFromatted){ //Your code here }</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
|
|
|
TextArea |
Represents text area.
Examples
The following code illustrates use of TextArea property:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Cone3DClustered;</para><para>//Create a chartLegend</para><para>IChartLegend chartLegend = chart.Legend;</para><para>chartLegend.LegendEntries[1].TextArea.Color = Color.Blue;</para><para>chartLegend.LegendEntries[1].TextArea.Size = 10;</para><para>chartLegend.LegendEntries[1].TextArea.FontName = "Bernard MT Condensed";</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
|
Methods
| Name | Description | |
|---|---|---|
|
Delete |
Deletes current legend entry.
Examples
The following code illustrates how to use Delete method for legend:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and set range</para><para>IChart chart = worksheet.Charts.Add();</para><para>chart.DataRange = worksheet.Range["B2:C6"];</para><para>//Set chart type</para><para>chart.ChartType = ExcelChartType.Cone3DClustered;</para><para>//Create a chartLegend</para><para>IChartLegend chartLegend = chart.Legend;</para><para>//Delete the first legend entry out of five entires</para><para>chartLegend.LegendEntries[0].Delete();</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
|
See Also
