Class ExternSheetRecord
The record stores a list with indexes to SUPBOOK records.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff(TBIFFRecord.ExternSheet)]
[CLSCompliant(false)]
public class ExternSheetRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable
Constructors
ExternSheetRecord()
Default constructor.
Declaration
public ExternSheetRecord()
ExternSheetRecord(Stream, out int)
Read / initialize constructor.
Declaration
public ExternSheetRecord(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. |
ExternSheetRecord(int)
Reserves for record's internal data array iReserve bytes.
Declaration
public ExternSheetRecord(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. |
Fields
MaximumRefsCount
Maximum references in one record.
Declaration
public const int MaximumRefsCount = 1370
Field Value
| Type |
|---|
| int |
Properties
MinimumRecordSize
Read-only. Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
| Type |
|---|
| int |
Overrides
RefCount
Number of following REF structures.
Declaration
public ushort RefCount { get; set; }
Property Value
| Type |
|---|
| ushort |
RefList
Gets list of references.
Declaration
public List<ExternSheetRecord.TREF> RefList { get; }
Property Value
| Type |
|---|
| List<ExternSheetRecord.TREF> |
Refs
List of REF structures.
Declaration
public ExternSheetRecord.TREF[] Refs { get; set; }
Property Value
| Type |
|---|
| TREF[] |
Methods
AddReference(int, int, int)
This method adds one TREF structure to the list.
Declaration
public int AddReference(int supIndex, int firstSheet, int lastSheet)
Parameters
| Type | Name | Description |
|---|---|---|
| int | supIndex | SUPBOOK index. |
| int | firstSheet | Index to first SUPBOOK sheet. |
| int | lastSheet | Index to last SUPBOOK sheet. |
Returns
| Type | Description |
|---|---|
| int | Index of the old REF structure (if there was one) or new REF structure. |
AppendReference(TREF)
Append Reference
Declaration
public void AppendReference(ExternSheetRecord.TREF reference)
Parameters
| Type | Name | Description |
|---|---|---|
| ExternSheetRecord.TREF | reference |
AppendReferences(IList<TREF>)
Append References
Declaration
public void AppendReferences(IList<ExternSheetRecord.TREF> refs)
Parameters
| Type | Name | Description |
|---|---|---|
| IList<ExternSheetRecord.TREF> | refs |
Clone()
Creates new instance
Declaration
public override object Clone()
Returns
| Type |
|---|
| object |
Overrides
GetBookReference(int)
Declaration
public int GetBookReference(int iBookIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iBookIndex |
Returns
| Type |
|---|
| int |
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()
Parse structure of record. Converts data buffer to special values according to record specification.
Declaration
public override void ParseStructure()
Overrides
PrependReferences(IList<TREF>)
Prepend References
Declaration
public void PrependReferences(IList<ExternSheetRecord.TREF> refs)
Parameters
| Type | Name | Description |
|---|---|---|
| IList<ExternSheetRecord.TREF> | refs |