Class SheetLayoutRecord
This record stores the colour of the tab below the sheet containing the sheet name.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class SheetLayoutRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
SheetLayoutRecord()
Default constructor
Declaration
public SheetLayoutRecord()
SheetLayoutRecord(Int32)
Reserved for record's internal data array.
Declaration
public SheetLayoutRecord(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. |
SheetLayoutRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public SheetLayoutRecord(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
DefaultRecordSize
Record size.
Declaration
public const int DefaultRecordSize = 20
Field Value
Type |
---|
System.Int32 |
Properties
ColorIndex
Color index for sheet name tab.
Declaration
public int ColorIndex { get; set; }
Property Value
Type |
---|
System.Int32 |
Id
Repeated record identifier.
Declaration
public short Id { get; set; }
Property Value
Type |
---|
System.Int16 |
MaximumMemorySize
Maximum memory size for internal buffer.
Declaration
public override int MaximumMemorySize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
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. Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Reserved1
Reserved.
Declaration
public int Reserved1 { get; set; }
Property Value
Type |
---|
System.Int32 |
Reserved2
Reserved.
Declaration
public int Reserved2 { get; set; }
Property Value
Type |
---|
System.Int32 |
Reserved3
Reserved.
Declaration
public short Reserved3 { get; set; }
Property Value
Type |
---|
System.Int16 |
Unknown
Unknown data.
Declaration
public int Unknown { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
GetStoreSize(ExcelVersion)
Size of the required storage space.
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. |