Class ChartDataFormatRecord
The DATAFORMAT record contains the zero-based numbers of the data point and series. The subordinate records determine the format of the series or point defined by the DATAFORMAT record.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.ChartDataFormat)]
public class ChartDataFormatRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartDataFormatRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartDataFormatRecord()
ChartDataFormatRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartDataFormatRecord(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. |
ChartDataFormatRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartDataFormatRecord(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
Correct size of the record.
Declaration
public const int DEF_RECORD_SIZE = 8
Field Value
Type | Description |
---|---|
System.Int32 |
Properties
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Overrides
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Overrides
Options
Options holder.
Declaration
public ushort Options { get; }
Property Value
Type | Description |
---|---|
System.UInt16 |
PointNumber
Point number (FFFFh means entire series).
Declaration
public ushort PointNumber { get; set; }
Property Value
Type | Description |
---|---|
System.UInt16 |
SeriesIndex
Series index (file relative).
Declaration
public ushort SeriesIndex { get; set; }
Property Value
Type | Description |
---|---|
System.UInt16 |
SeriesNumber
Series number (as shown in name box -- S1, S2, etc.). This can be different from yi if the series order has been changed.
Declaration
public ushort SeriesNumber { get; set; }
Property Value
Type | Description |
---|---|
System.UInt16 |
UserExcel4Colors
True to use Microsoft Excel 4.0 colors for automatic formatting.
Declaration
public bool UserExcel4Colors { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
GetStoreSize(ExcelVersion)
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type | Description |
---|---|
System.Int32 |
Overrides
ParseStructure(DataProvider, Int32, Int32, ExcelVersion)
Parse structure of record. Convert 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. |