Class HeaderAndFooterRecord
Represents the Header Footer Record
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class HeaderAndFooterRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
HeaderAndFooterRecord()
Default constructor, initializes all fields with default values.
Declaration
public HeaderAndFooterRecord()
HeaderAndFooterRecord(Int32)
Reserved for record's internal data array.
Declaration
public HeaderAndFooterRecord(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. |
HeaderAndFooterRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public HeaderAndFooterRecord(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
AlignHFWithPageMargins
Gets or sets if Align HeaderFoote With PageMargins
Declaration
public bool AlignHFWithPageMargins { get; set; }
Property Value
Type |
---|
System.Boolean |
DifferentFirstPageHF
Gets or sets the value of Different First Page Header Footer
Declaration
public bool DifferentFirstPageHF { get; set; }
Property Value
Type |
---|
System.Boolean |
DifferentOddAndEvenPagesHF
Gets or sets the value of Different Odd and Even Page Header Footer
Declaration
public bool DifferentOddAndEvenPagesHF { get; set; }
Property Value
Type |
---|
System.Boolean |
HFScaleWithDoc
Gets or sets if the HeaderFooter is sclaed with document
Declaration
public bool HFScaleWithDoc { get; set; }
Property Value
Type |
---|
System.Boolean |
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. |