Class SupBookRecord

This record stores the URL of an external document and a list of sheet names inside this document. Furthermore, it is used to store DDE and OLE object links or to indicate an internal 3D reference or an add-in function.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordWithStreamPos
BiffRecordRawWithDataProvider
BiffRecordWithContinue
SupBookRecord
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
[CLSCompliant(false)]
[Biff(TBIFFRecord.SupBook)]
public class SupBookRecord : BiffRecordWithContinue, ICloneable, IBiffStorage, IDisposable

Constructors

SupBookRecord()

Default constructor

Declaration
public SupBookRecord()

Fields

ADDIN_FUNCTION

This constant indicates that the sup book record contains add-in functions.

Declaration
public const ushort ADDIN_FUNCTION = 14849
Field Value
Type
System.UInt16

INTERNAL_REFERENCE

This constant indicates that the sup book record contains internal references.

Declaration
public const ushort INTERNAL_REFERENCE = 1025
Field Value
Type
System.UInt16

Properties

IsAddInFunctions

Declaration
public bool IsAddInFunctions { get; set; }
Property Value
Type
System.Boolean

MaximumRecordSize

Read-only. Maximum possible size of the record.

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

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

OriginalURL

Gets / sets original url value.

Declaration
public string OriginalURL { get; set; }
Property Value
Type
System.String

SheetNames

List of sheet names.

Declaration
public List<string> SheetNames { get; set; }
Property Value
Type
System.Collections.Generic.List<System.String>

SheetNumber

Number of sheet names (if external references) or number of sheets in this document (if internal references).

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

URL

Encoded URL without sheet name (for external references).

Declaration
public string URL { get; set; }
Property Value
Type
System.String

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
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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 string's length does not fit to internal data length or when last string ends before data (some extra data at the end of m_data array).

Implements

System.ICloneable
System.IDisposable