Class ChartCategoryCollection

Represents a collection of chart categories.

Inheritance
System.Object
CollectionBase<IChartCategory>
CollectionBaseEx<IChartCategory>
ChartCategoryCollection
Implements
System.Collections.Generic.IList<IChartCategory>
System.Collections.Generic.ICollection<IChartCategory>
System.Collections.Generic.IEnumerable<IChartCategory>
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ChartCategoryCollection : CollectionBaseEx<IChartCategory>, IChartCategories, IParentApplication, ICloneParent, IList<IChartCategory>, ICollection<IChartCategory>, IEnumerable<IChartCategory>, IEnumerable

Constructors

ChartCategoryCollection(IApplication, Object)

Initializes a new instance of ChartCategoryCollection class.

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

Application object for the collection.
System.Object parent

Parent object for the collection.

Properties

Item[Int32]

Gets a single category object with the specified index.

Declaration
public ChartCategory this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type Description
ChartCategory

Item[String]

Gets a single category object with the specified name.

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

Methods

Add()

Adds a new serie to this collection.

Declaration
public IChartCategory Add()
Returns
Type Description
IChartCategory

The added serie.

Add(ExcelChartType)

Adds a new serie with the specified serie type to this collection.

Declaration
public IChartCategory Add(ExcelChartType serieType)
Parameters
Type Name Description
ExcelChartType serieType

The Serie type to be added.
Returns
Type Description
IChartCategory

The added serie.

Add(ChartSerieImpl)

Adds the specified series to this collection.

Declaration
public IChartCategory Add(ChartSerieImpl serieToAdd)
Parameters
Type Name Description
ChartSerieImpl serieToAdd

Series that should be added to the collection.
Returns
Type Description
IChartCategory

The added serie.

Add(IRange, IRange)

Adds a new serie with the specified range of category labels and category values to this collection.

Declaration
public IChartCategory Add(IRange Categorylabel, IRange Values)
Parameters
Type Name Description
IRange Categorylabel

Category labels for the serie to be added.
IRange Values

Category values for the serie to be added.
Returns
Type Description
IChartCategory

The added serie.

Add(String)

Adds a new serie with the specified name to this collection.

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

Name of the serie.
Returns
Type Description
IChartCategory

The added serie.

Add(String, ExcelChartType)

Adds a new serie with the specified serie type and name to this collection.

Declaration
public IChartCategory Add(string name, ExcelChartType serieType)
Parameters
Type Name Description
System.String name

Name of the serie to be added.
ExcelChartType serieType

Serie type for the serie.
Returns
Type Description
IChartCategory

The added Serie.

Clone(Object)

Clone current instance.

Declaration
public override object Clone(object parent)
Parameters
Type Name Description
System.Object parent

Parent object.
Returns
Type Description
System.Object

Returns cloned instance.
Overrides
Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.XlsIO.IChartCategory>.Clone(System.Object)

GetEnteredRecords(Int32)

Returns array of entered records.

Declaration
public List<BiffRecordRaw> GetEnteredRecords(int siIndex)
Parameters
Type Name Description
System.Int32 siIndex

Si record index.
Returns
Type Description
System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>

Returns array of entered records.

OnClear()

Performs additional operations before the Clear method.

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

Remove(String)

Removes the serie with the specified name from this collection.

Declaration
public void Remove(string serieName)
Parameters
Type Name Description
System.String serieName

Name of the serie to be removed.

Implements

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