Class PaletteRecord
This record contains the definition of all user-defined colors available for cell and object formatting.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff]
public class PaletteRecord : BiffRecordRaw, ICloneable, IBiffStorageConstructors
PaletteRecord()
Default constructor fills all data with default values.
Declaration
public PaletteRecord()PaletteRecord(Int32)
Reserved for record's internal data array.
Declaration
public PaletteRecord(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. |
PaletteRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public PaletteRecord(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. |
Properties
Colors
Array of colors.
Declaration
public PaletteRecord.TColor[] Colors { get; set; }Property Value
| Type |
|---|
| PaletteRecord.TColor[] |
ColorsCount
Read-only. Number of colors (nm). Contains 16 in BIFF3-BIFF4 and 56 in BIFF5-BIFF8.
Declaration
public ushort ColorsCount { get; }Property Value
| Type |
|---|
| System.UInt16 |
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }Property Value
| Type |
|---|
| 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 |
|---|
| System.Int32 |
Overrides
Methods
GetStoreSize(ExcelVersion)
Size of the required storage space. Read-only.
Declaration
public override int GetStoreSize(ExcelVersion version)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version |
Returns
| Type |
|---|
| 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. |