Class HeaderFooterRecord
Specifies a header for a sheet.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff(TBIFFRecord.Header)]
[Biff(TBIFFRecord.Footer)]
[CLSCompliant(false)]
public class HeaderFooterRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
HeaderFooterRecord()
Default constructor
Declaration
public HeaderFooterRecord()
HeaderFooterRecord(Stream, out int)
Read / initialize constructor.
Declaration
public HeaderFooterRecord(Stream stream, out int itemSize)
Parameters
| Type | Name | Description |
|---|---|---|
| Stream | stream | Stream from which record data should be read. |
| int | itemSize | Size of read item. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | If stream is not specified. |
| ApplicationException | If stream does not support read or seek operations. |
HeaderFooterRecord(int)
Reserved for record's internal data array.
Declaration
public HeaderFooterRecord(int iReserve)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iReserve | Amount of bytes for data array. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
Properties
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
| Type |
|---|
| int |
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize
Value
Header string.
Declaration
public string Value { get; set; }
Property Value
| Type |
|---|
| string |
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 |
|---|
| int |
Overrides
ParseStructure(DataProvider, int, int, 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. |
| int | iOffset | Offset to the record's data. |
| int | iLength | Length of the record's data. |
| ExcelVersion | version | Excel version used for infill. |