Class ExternSheetRecord

The record stores a list with indexes to SUPBOOK records.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
ExternSheetRecord
Implements
System.ICloneable
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ExternSheet)]
[CLSCompliant(false)]
public class ExternSheetRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable

Constructors

ExternSheetRecord()

Default constructor.

Declaration
public ExternSheetRecord()

ExternSheetRecord(Int32)

Reserves for record's internal data array iReserve bytes.

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

ExternSheetRecord(Stream, out Int32)

Read / initialize constructor.

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

Fields

MaximumRefsCount

Maximum references in one record.

Declaration
public const int MaximumRefsCount = 1370
Field Value
Type
System.Int32

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

RefCount

Number of following REF structures.

Declaration
public ushort RefCount { get; set; }
Property Value
Type
System.UInt16

RefList

Gets list of references.

Declaration
public List<ExternSheetRecord.TREF> RefList { get; }
Property Value
Type
System.Collections.Generic.List<ExternSheetRecord.TREF>

Refs

List of REF structures.

Declaration
public ExternSheetRecord.TREF[] Refs { get; set; }
Property Value
Type
ExternSheetRecord.TREF[]

Methods

AddReference(Int32, Int32, Int32)

This method adds one TREF structure to the list.

Declaration
public int AddReference(int supIndex, int firstSheet, int lastSheet)
Parameters
Type Name Description
System.Int32 supIndex

SUPBOOK index.
System.Int32 firstSheet

Index to first SUPBOOK sheet.
System.Int32 lastSheet

Index to last SUPBOOK sheet.
Returns
Type Description
System.Int32

Index of the old REF structure (if there was one) or new REF structure.

AppendReference(ExternSheetRecord.TREF)

Append Reference

Declaration
public void AppendReference(ExternSheetRecord.TREF reference)
Parameters
Type Name Description
ExternSheetRecord.TREF reference

AppendReferences(IList<ExternSheetRecord.TREF>)

Append References

Declaration
public void AppendReferences(IList<ExternSheetRecord.TREF> refs)
Parameters
Type Name Description
System.Collections.Generic.IList<ExternSheetRecord.TREF> refs

Clone()

Creates new instance

Declaration
public override object Clone()
Returns
Type
System.Object
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.Clone()

GetBookReference(Int32)

Declaration
public int GetBookReference(int iBookIndex)
Parameters
Type Name Description
System.Int32 iBookIndex
Returns
Type
System.Int32

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

PrependReferences(IList<ExternSheetRecord.TREF>)

Prepend References

Declaration
public void PrependReferences(IList<ExternSheetRecord.TREF> refs)
Parameters
Type Name Description
System.Collections.Generic.IList<ExternSheetRecord.TREF> refs

Implements

System.ICloneable
System.IDisposable