Class HorizontalPageBreaksRecord

Contains a list of explicit column page breaks.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
HorizontalPageBreaksRecord
Implements
System.ICloneable
System.IDisposable
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class HorizontalPageBreaksRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable

Constructors

HorizontalPageBreaksRecord()

Default constructor, sets all fields' default values.

Declaration
public HorizontalPageBreaksRecord()

HorizontalPageBreaksRecord(Int32)

Reserved for record's internal data array.

Declaration
public HorizontalPageBreaksRecord(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.

HorizontalPageBreaksRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public HorizontalPageBreaksRecord(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

MinimumRecordSize

Read-only. Minimum possible size of the record.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

PageBreaks

Array of HorizontalPageBreaks.

Declaration
public HorizontalPageBreaksRecord.THPageBreak[] PageBreaks { get; set; }
Property Value
Type
HorizontalPageBreaksRecord.THPageBreak[]

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()

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure()
Overrides
Exceptions
Type Condition
WrongBiffRecordDataException

When data array does not fit to the page breaks array.

Implements

System.ICloneable
System.IDisposable