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