Click or drag to resize

XlsChartFormatCollection Class

Represents a collection of chart format objects within an Excel document.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet.Collections CollectionBase XlsChartFormat
Spire.Xls.Core.Spreadsheet.Collections CollectionExtended XlsChartFormat
Spire.Xls.Core.Spreadsheet.Charts XlsChartFormatCollection
Spire.Xls.Charts ChartFormatCollection

Namespace: Spire.Xls.Core.Spreadsheet.Charts
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsChartFormatCollection : CollectionExtended<XlsChartFormat>

The XlsChartFormatCollection type exposes the following members.

Properties
Name Description
Public property Capacity
Gets or sets the number of elements that the System.Collections.CollectionBase can contain.
(Inherited from CollectionBase T .)
Public property Count
Gets the number of elements contained in the System.Collections.CollectionBase instance.
(Inherited from CollectionBase T .)
Protected property InnerList
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property IsPrimary
Indicates whether collection represents formats for primary axis;
Public property IsReadOnly
Gets a value indicating whether the collection is read-only.
(Inherited from CollectionBase T .)
Public property Item
Returns single format by DrawingZOrder. Read-only.
Protected property List
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property NeedSecondaryAxis
Returns true if this collection is primary and contain series that need secondary axis.
Public property Parent
Read-oonly. The parent object for the specified object.
(Inherited from CollectionExtended T .)
Top
Methods
Name Description
Public method Add(XlsChartFormat)
Adds the specified chart format to the current chart format settings.
Public method Add(XlsChartFormat, Boolean)
Adds or replaces a chart format in the collection based on the specified condition.
Public method Clear
Removes all objects from the System.Collections.CollectionBase instance.
(Inherited from CollectionBase T .)
Public method Clone Obsolete.
Clones current object.
(Overrides CollectionExtended T Clone(Object) .)
Public method Contains
Determines whether the collection contains a specific item.
(Inherited from CollectionBase T .)
Public method ContainsIndex
Determines whether the collection contains an element at the specified index.
Public method CopyTo
Copies the elements of the collection to an array, starting at a particular array index.
(Inherited from CollectionBase T .)
Public method EnsureCapacity
Enlarges internal storage if necessary.
(Inherited from CollectionExtended T .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method FindOrAdd
Finds an existing XlsChartFormat that matches the provided format or adds the new format if it does not exist.
Protected method FindParent(Type)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Protected method FindParent(Type, Boolean)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Public method GetEnumerator
Returns an enumerator that iterates through this instance.
(Inherited from CollectionBase T .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method IndexOf
Returns the zero-based index of the first occurrence of a specified item within the collection.
(Inherited from CollectionBase T .)
Public method Insert
Inserts an element into the list at the specified index.
(Inherited from CollectionBase T .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnClear
OnClear is invoked before Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnClearComplete
OnClear is invoked after Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnInsert
Performs additional processes before inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnInsertComplete
Performs additional processes after inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemove
Performs additional processes before removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemoveComplete
Performs additional processes after removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnSet
Performs additional processes before setting a value in the collection.
(Inherited from CollectionExtended T .)
Protected method OnSetComplete
Performs additional processes after setting a value in the collection.
(Inherited from CollectionExtended T .)
Public method Remove
Removes the first occurrence of a specific object from the collection.
(Inherited from CollectionBase T .)
Public method RemoveAt
Removes the element at the specified index of this instance.
(Inherited from CollectionBase T .)
Public method SetIndex Obsolete.
Sets value by index.
Protected method SetParent
Sets parent object for class.
(Inherited from CollectionExtended T .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method UpdateFormatsOnAdding Obsolete.
Updates formats on adding format.
Public method UpdateFormatsOnRemoving Obsolete.
Updates formats on removing.
Public method UpdateIndexesAfterRemove Obsolete.
Updates indexes in collection after remove.
Public method UpdateSeriesByChartGroup Obsolete.
Changes serie chart group in all series.
Top
Events
See Also