menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SupBookRecord - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    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
    IBiffStorage
    System.IDisposable
    Inherited Members
    BiffRecordRawWithDataProvider.Dispose()
    BiffRecordRawWithDataProvider.Finalize()
    BiffRecordRawWithDataProvider.GetString(Int32, Int32)
    BiffRecordRawWithDataProvider.GetString(Int32, Int32, Int32)
    BiffRecordRawWithDataProvider.GetString(Int32, Int32, Int32, Boolean)
    BiffRecordRawWithDataProvider.GetUnkTypeString(Int32, IList<Int32>, Int32, Int32, Int32, Byte[], Byte[])
    BiffRecordRawWithDataProvider.m_provider
    BiffRecordRawWithDataProvider.ParseStructure(DataProvider, Int32, Int32, ExcelVersion)
    BiffRecordRawWithDataProvider.SetByte(Int32, Byte)
    BiffRecordRawWithDataProvider.SetBytes(Int32, Byte[])
    BiffRecordRawWithDataProvider.SetBytes(Int32, Byte[], Int32, Int32)
    BiffRecordRawWithDataProvider.SetStringNoLen(Int32, String)
    BiffRecordRawWithDataProvider.SetStringNoLen(Int32, String, Boolean)
    BiffRecordRawWithDataProvider.SetUInt16(Int32, UInt16)
    BiffRecordWithContinue.AddHeaderToProvider
    BiffRecordWithContinue.Clone()
    BiffRecordWithContinue.FillRecord(BinaryReader, DataProvider, IDecryptor, Byte[])
    BiffRecordWithContinue.FillStream(BinaryWriter, DataProvider, IEncryptor, Int32)
    BiffRecordWithContinue.FirstContinueType
    BiffRecordWithContinue.m_iFirstLength
    BiffRecordWithStreamPos.m_lStreamPosition
    BiffRecordWithStreamPos.StreamPos
    Namespace: Syncfusion.XlsIO.Parser.Biff_Records
    Assembly: Syncfusion.XlsIO.UWP.dll
    Syntax
    [Biff]
    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
    BiffRecordRawWithDataProvider.ParseStructure()
    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
    IBiffStorage
    System.IDisposable

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved