ChartFormatCollection Class

Represents collection of ChartFormatImpl.

Inheritance

System.Object

Syncfusion.XlsIO.Implementation.Collections.CollectionBase<ChartFormatImpl>

Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<ChartFormatImpl>

ChartFormatCollection

Implements

System.Collections.Generic.IList<ChartFormatImpl>

System.Collections.Generic.ICollection<ChartFormatImpl>

System.Collections.Generic.IEnumerable<ChartFormatImpl>

System.Collections.IEnumerable

IParentApplication

ICloneParent

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Implementation.Charts

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class ChartFormatCollection : CollectionBaseEx<ChartFormatImpl>, IList<ChartFormatImpl>, ICollection<ChartFormatImpl>, IEnumerable<ChartFormatImpl>, IEnumerable, IParentApplication, ICloneParent

Constructors

ChartFormatCollection(IApplication, Object)

Creates new instance of collection.

Declaration

public ChartFormatCollection(IApplication application, object parent)

Parameters

Type	Name	Description
IApplication	application	Application object.
System.Object	parent	Parent object.

Fields

DEF_ARRAY_CAPACITY

Represents capacity of array.

Declaration

public const int DEF_ARRAY_CAPACITY = 8

Field Value

Type
System.Int32

Properties

IsPrimary

If true - this collection represents formats for primary axis; otherwise - secondary collection.

Declaration

public bool IsPrimary { get; }

Property Value

Type
System.Boolean

Item[Int32]

Returns single format by DrawingZOrder. Read-only.

Declaration

public ChartFormatImpl this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
ChartFormatImpl

NeedSecondaryAxis

Returns true if this collection is primary and contain series that need secondary axis.

Declaration

public bool NeedSecondaryAxis { get; }

Property Value

Type
System.Boolean

Methods

Add(ChartFormatImpl)

Adds chart format.

Declaration

public ChartFormatImpl Add(ChartFormatImpl formatToAdd)

Parameters

Type	Name	Description
ChartFormatImpl	formatToAdd

Returns

Type
ChartFormatImpl

Add(ChartFormatImpl, Boolean)

Adds new format.

Declaration

public ChartFormatImpl Add(ChartFormatImpl formatToAdd, bool bCanReplace)

Parameters

Type	Name	Description
ChartFormatImpl	formatToAdd	Chartformat to add.
System.Boolean	bCanReplace

Returns

Type	Description
ChartFormatImpl	Returns just added format.

AddFormat(ChartFormatImpl)

Shallow adds format to collection.

Declaration

public void AddFormat(ChartFormatImpl format)

Parameters

Type	Name	Description
ChartFormatImpl	format	Format to add.

Clear()

Clears current collection.

Declaration

public void Clear()

Clone(Object)

Clones current object.

Declaration

public override object Clone(object parent)

Parameters

Type	Name	Description
System.Object	parent	Parent object.

Returns

Type	Description
System.Object	Returns cloned object.

Overrides

Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.XlsIO.Implementation.Charts.ChartFormatImpl>.Clone(System.Object)

ContainsIndex(Int32)

Checks for containing index in collection.

Declaration

public bool ContainsIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	Index to check.

Returns

Type	Description
System.Boolean	If contains - returns true; otherwise - false.

FindOrAdd(ChartFormatImpl)

Checks whether similar format is already present in the collection and returns it, otherwise it add new format.

Declaration

public ChartFormatImpl FindOrAdd(ChartFormatImpl formatToAdd)

Parameters

Type	Name	Description
ChartFormatImpl	formatToAdd	Format that should be placed in the collection.

Returns

Type	Description
ChartFormatImpl	Format from the collection.

GetFormat(Int32, Boolean)

Gets format by index, and shallow removes current format.

Declaration

public ChartFormatImpl GetFormat(int iOrder, bool bDelete)

Parameters

Type	Name	Description
System.Int32	iOrder	Format order.
System.Boolean	bDelete	If true - delete current format.

Returns

Type	Description
ChartFormatImpl	Format by index.

Remove(ChartFormatImpl)

Removes formats by instance.

Declaration

public void Remove(ChartFormatImpl toRemove)

Parameters

Type	Name	Description
ChartFormatImpl	toRemove	Removes current instance.

SetIndex(Int32, Int32)

Sets value by index.

Declaration

public void SetIndex(int index, int Value)

Parameters

Type	Name	Description
System.Int32	index	Index to set.
System.Int32	Value	Value to set.

SetParents()

Sets parent objects.

Declaration

public void SetParents()

UpdateFormatsOnAdding(Int32)

Updates formats on adding format.

Declaration

public void UpdateFormatsOnAdding(int index)

Parameters

Type	Name	Description
System.Int32	index	Index to updates.

UpdateFormatsOnRemoving(Int32)

Updates formats on removing.

Declaration

public void UpdateFormatsOnRemoving(int index)

Parameters

Type	Name	Description
System.Int32	index	Index to update.

UpdateIndexesAfterRemove(Int32)

Updates indexes in collection after remove.

Declaration

public void UpdateIndexesAfterRemove(int removeIndex)

Parameters

Type	Name	Description
System.Int32	removeIndex	Index of removed format.

UpdateSeriesByChartGroup(Int32, Int32)

Changes Series chart group in all series.

Declaration

public void UpdateSeriesByChartGroup(int newIndex, int OldIndex)

Parameters

Type	Name	Description
System.Int32	newIndex	New index.
System.Int32	OldIndex	Old Index.

Implements

System.Collections.Generic.IList<T>

System.Collections.Generic.ICollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

IParentApplication

ICloneParent