Class ChartsCollection

Collection of the Charts object.

Inheritance
System.Object
CollectionBase<IChart>
CollectionBaseEx<IChart>
ChartsCollection
Implements
System.Collections.Generic.IList<IChart>
System.Collections.Generic.ICollection<IChart>
System.Collections.Generic.IEnumerable<IChart>
System.Collections.IEnumerable
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
public class ChartsCollection : CollectionBaseEx<IChart>, IList<IChart>, ICollection<IChart>, IEnumerable<IChart>, ICloneParent, ICharts, IEnumerable, IParentApplication

Constructors

ChartsCollection(IApplication, Object)

Creates chart collection.

Declaration
public ChartsCollection(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the collection.
System.Object parent

Parent object for the collection.

Fields

DEF_CHART_NAME_START

Default start of the chart name.

Declaration
public const string DEF_CHART_NAME_START = "Chart"
Field Value
Type
System.String

Properties

Item[String]

Returns a single Chart object from a Charts collection.

Declaration
public IChart this[string name] { get; }
Parameters
Type Name Description
System.String name
Property Value
Type
IChart

Methods

Add()

Creates a new chart.

Declaration
public IChart Add()
Returns
Type Description
IChart

Newly created chart object.

Add(IChart)

Adds specified chart to the collection.

Declaration
public IChart Add(IChart chartToAdd)
Parameters
Type Name Description
IChart chartToAdd

Chart that should be added to the collection.
Returns
Type Description
IChart

Added chart object.

Add(BiffReader)

Extracts chart object from the BiffReader.

Declaration
public IChart Add(BiffReader reader)
Parameters
Type Name Description
BiffReader reader

BiffReader that contains chart data.
Returns
Type Description
IChart

Extracted chart.

Add(BiffReader, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

Extracts chart object from the BiffReader.

Declaration
public IChart Add(BiffReader reader, ExcelParseOptions options, bool bSkip, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)
Parameters
Type Name Description
BiffReader reader

BiffReader that contains chart data.
ExcelParseOptions options

Parse options.
System.Boolean bSkip

Indicates whether skip parsing.
System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashNewXFormatIndexes

Dictionary with new extended format indexes for ignore styles mode.
IDecryptor decryptor

Object used to decrypt encrypted records.
Returns
Type Description
IChart

Extracted chart.

Add(String)

Defines a new name.

Declaration
public IChart Add(string name)
Parameters
Type Name Description
System.String name

Name of the new chart's sheet.
Returns
Type Description
IChart

Newly created chart object.

AddCopy(IChart)

Adds copy of the specified chart to the collection.

Declaration
public void AddCopy(IChart chartToCopy)
Parameters
Type Name Description
IChart chartToCopy

Chart to copy.

Move(Int32, Int32)

Moves worksheet inside this collection only.

Declaration
public void Move(int iOldIndex, int iNewIndex)
Parameters
Type Name Description
System.Int32 iOldIndex

Old index in the collection.
System.Int32 iNewIndex

New index in the collection.

OnClear()

Performs additional operations before Clear method execution.

Declaration
protected override void OnClear()
Overrides
Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.XlsIO.IChart>.OnClear()

Remove(String)

Removes Chart object from the collection.

Declaration
public IChart Remove(string name)
Parameters
Type Name Description
System.String name

Name of the object to remove from the collection.
Returns
Type
IChart

Implements

System.Collections.Generic.IList<>
System.Collections.Generic.ICollection<>
System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable