Class PaneRecord
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.Pane)]
public class PaneRecord : BiffRecordRaw, ICloneable, IBiffStorageConstructors
PaneRecord()
Default constructor
Declaration
public PaneRecord()PaneRecord(Int32)
Reserved for record's internal data array.
Declaration
public PaneRecord(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. |
PaneRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public PaneRecord(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
ActivePane
Identifier of pane with active cell cursor (see below). The last field specifying the active pane has a size of 1 byte in BIFF2-BIFF4 and 2 bytes in BIFF5-BIFF8. The correct identifiers for all possible combinations of visible panes are shown in the following pictures: px=0, py=0 -> 3 px=0, py>0 -> 3 2 px>0, py=0 -> 3 1 px>0, py>0 -> 3 1 2 0
Declaration
public ushort ActivePane { get; set; }Property Value
| Type | Description |
|---|---|
| System.UInt16 |
FirstColumn
Index to first visible column in right pane(s).
Declaration
public int FirstColumn { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
FirstRow
Index to first visible row in bottom pane(s).
Declaration
public int FirstRow { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
HorizontalSplit
Position of the horizontal split (py, 0 = No horizontal split). Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point). Frozen pane: Number of visible rows in top pane(s).
Declaration
public int HorizontalSplit { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
MaximumRecordSize
Read-only. Returns maximum possible size of record's internal data array.
Declaration
public override int MaximumRecordSize { get; }Property Value
| Type | Description |
|---|---|
| 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 | Description |
|---|---|
| System.Int32 |
Overrides
VerticalSplit
Position of the vertical split (px, 0 = No vertical split). Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point). Frozen pane: Number of visible columns in left pane(s).
Declaration
public int VerticalSplit { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
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 | Description |
|---|---|
| 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. |