Class ChartSeriesListRecord

This record is subordinate to the second CHARTFORMAT (overlay) record in a file and defines the series that are displayed as the overlay to the main chart. The first CHARTFORMAT (main chart) record in a file does not require a SERIESLIST record because all series, except those specified for the overlay, are included in the main chart.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
ChartSeriesListRecord
Implements
System.ICloneable
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class ChartSeriesListRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ChartSeriesListRecord()

Default constructor, initializes all fields with default values.

Declaration
public ChartSeriesListRecord()

ChartSeriesListRecord(Int32)

Reserved for record's internal data array.

Declaration
public ChartSeriesListRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

ChartSeriesListRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public ChartSeriesListRecord(Stream stream, out int itemSize)
Parameters
Type Name Description
System.IO.Stream stream

Stream from which record data should be read.
System.Int32 itemSize

Size of read item.
Exceptions
Type Condition
System.ArgumentNullException

If stream is not specified.
System.ApplicationException

If stream does not support read or seek operations.

Fields

DEF_RECORD_SIZE

Minimum size of the record.

Declaration
public const int DEF_RECORD_SIZE = 2
Field Value
Type
System.Int32

Properties

MinimumRecordSize

Minimum possible size of the record.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

Series

List of series numbers (words).

Declaration
public ushort[] Series { get; set; }
Property Value
Type
System.UInt16[]

SeriesCount

Count of series. Read-only.

Declaration
public ushort SeriesCount { get; }
Property Value
Type
System.UInt16

Methods

Clone()

Clones current record.

Declaration
public override object Clone()
Returns
Type Description
System.Object

Returns cloned record.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.Clone()

GetStoreSize(ExcelVersion)

Evaluates size of the required storage space.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32

Size of the required storage space.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 iOffset

Offset to the record's data.
System.Int32 iLength

Length of the record's data.
ExcelVersion version

Excel version used for infill.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Operators

Equality(ChartSeriesListRecord, ChartSeriesListRecord)

Operator to check if the records are equal

Declaration
public static bool operator ==(ChartSeriesListRecord record1, ChartSeriesListRecord record2)
Parameters
Type Name Description
ChartSeriesListRecord record1
ChartSeriesListRecord record2
Returns
Type
System.Boolean

Inequality(ChartSeriesListRecord, ChartSeriesListRecord)

Checks and returns if the records are not equal

Declaration
public static bool operator !=(ChartSeriesListRecord record1, ChartSeriesListRecord record2)
Parameters
Type Name Description
ChartSeriesListRecord record1
ChartSeriesListRecord record2
Returns
Type
System.Boolean

Implements

System.ICloneable