Class ChartLegendEntriesColl
Represents collection of ChartLegendEntries in chart legend.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
public class ChartLegendEntriesColl : CommonObject, IParentApplication, IDisposable, IChartLegendEntries
Constructors
ChartLegendEntriesColl(IApplication, object)
Creates new instance of Legend entry collection.
Declaration
public ChartLegendEntriesColl(IApplication application, object parent)
Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Represents current application. |
| object | parent | Parent object. |
Properties
Count
Represents count of legend entries in collection. Read-only.
Declaration
public int Count { get; }
Property Value
| Type |
|---|
| int |
this[int]
Gets legend entry object by index. Read-only.
Declaration
public IChartLegendEntry this[int iIndex] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex |
Property Value
| Type |
|---|
| IChartLegendEntry |
Methods
Add(int)
Adds legend to collection by index.
Declaration
public ChartLegendEntryImpl Add(int iIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex | Represents index of new entry in collection.( Zero based ) |
Returns
| Type | Description |
|---|---|
| ChartLegendEntryImpl | Returns added entry. |
Add(int, ChartLegendEntryImpl)
Adds legend to collection by index.
Declaration
public ChartLegendEntryImpl Add(int iIndex, ChartLegendEntryImpl entry)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex | Represents index of new entry in collection.( Zero based ) |
| ChartLegendEntryImpl | entry | Represents entry to add. |
Returns
| Type | Description |
|---|---|
| ChartLegendEntryImpl | Returns added entry. |
CanDelete(int)
Checks before deleting legend entry.
Declaration
public bool CanDelete(int iIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex | Represents index in collection. |
Returns
| Type | Description |
|---|---|
| bool | If true - can delete; otherwise false. |
Clear()
Clears current collection.
Declaration
public void Clear()
Clone(object, Dictionary<int, int>, Dictionary<string, string>)
Clones current object.
Declaration
public ChartLegendEntriesColl Clone(object parent, Dictionary<int, int> dicIndexes, Dictionary<string, string> dicNewSheetNames)
Parameters
| Type | Name | Description |
|---|---|---|
| object | parent | Parent for cloned object. |
| Dictionary<int, int> | dicIndexes | Represents list with new font indexes. |
| Dictionary<string, string> | dicNewSheetNames | Dictionary with new worksheet names. |
Returns
| Type | Description |
|---|---|
| ChartLegendEntriesColl | Returns cloned object. |
Contains(int)
Checks for contain changed from default formatting legend entry by index.
Declaration
public bool Contains(int iIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex | Represents legend entry index. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if contains otherwise false. |
Remove(int)
Updates legend entries collection after removing series.
Declaration
public void Remove(int iIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iIndex | Index of legend entry to remove. |
UpdateEntries(int, int)
Adds value to entry indexes.
Declaration
public void UpdateEntries(int entryIndex, int value)
Parameters
| Type | Name | Description |
|---|---|---|
| int | entryIndex | Represents start entry index. |
| int | value | Represents value to add. |