alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class ExternBookCollection

    Collection of external workbooks in the worksheet.

    Inheritance
    object
    CollectionBase<ExternWorkbookImpl>
    CollectionBaseEx<ExternWorkbookImpl>
    ExternBookCollection
    Implements
    IList<ExternWorkbookImpl>
    ICollection<ExternWorkbookImpl>
    IEnumerable<ExternWorkbookImpl>
    IEnumerable
    IParentApplication
    ICloneParent
    Inherited Members
    CollectionBase<ExternWorkbookImpl>.Capacity
    CollectionBase<ExternWorkbookImpl>.Clear()
    CollectionBase<ExternWorkbookImpl>.Contains(ExternWorkbookImpl)
    CollectionBase<ExternWorkbookImpl>.CopyTo(ExternWorkbookImpl[], int)
    CollectionBase<ExternWorkbookImpl>.Count
    CollectionBase<ExternWorkbookImpl>.GetEnumerator()
    CollectionBase<ExternWorkbookImpl>.IndexOf(ExternWorkbookImpl)
    CollectionBase<ExternWorkbookImpl>.InnerList
    CollectionBase<ExternWorkbookImpl>.Insert(int, ExternWorkbookImpl)
    CollectionBase<ExternWorkbookImpl>.IsReadOnly
    CollectionBase<ExternWorkbookImpl>.List
    CollectionBase<ExternWorkbookImpl>.Remove(ExternWorkbookImpl)
    CollectionBase<ExternWorkbookImpl>.RemoveAt(int)
    CollectionBaseEx<ExternWorkbookImpl>.AppImplementation
    CollectionBaseEx<ExternWorkbookImpl>.Application
    CollectionBaseEx<ExternWorkbookImpl>.Changed
    CollectionBaseEx<ExternWorkbookImpl>.ChangeName(IDictionary, ValueChangedEventArgs)
    CollectionBaseEx<ExternWorkbookImpl>.Cleared
    CollectionBaseEx<ExternWorkbookImpl>.Clearing
    CollectionBaseEx<ExternWorkbookImpl>.ClearMaxValues()
    CollectionBaseEx<ExternWorkbookImpl>.Clone(object)
    CollectionBaseEx<ExternWorkbookImpl>.EnsureCapacity(int)
    CollectionBaseEx<ExternWorkbookImpl>.FindParent(Type)
    CollectionBaseEx<ExternWorkbookImpl>.FindParent(Type, bool)
    CollectionBaseEx<ExternWorkbookImpl>.GenerateDefaultName(ICollection<ExternWorkbookImpl>, string)
    CollectionBaseEx<ExternWorkbookImpl>.GenerateDefaultName(ICollection, string)
    CollectionBaseEx<ExternWorkbookImpl>.GenerateDefaultName(string, params ICollection[])
    CollectionBaseEx<ExternWorkbookImpl>.Inserted
    CollectionBaseEx<ExternWorkbookImpl>.Inserting
    CollectionBaseEx<ExternWorkbookImpl>.OnClear()
    CollectionBaseEx<ExternWorkbookImpl>.OnClearComplete()
    CollectionBaseEx<ExternWorkbookImpl>.OnInsert(int, ExternWorkbookImpl)
    CollectionBaseEx<ExternWorkbookImpl>.OnRemove(int, ExternWorkbookImpl)
    CollectionBaseEx<ExternWorkbookImpl>.OnRemoveComplete(int, ExternWorkbookImpl)
    CollectionBaseEx<ExternWorkbookImpl>.OnSet(int, ExternWorkbookImpl, ExternWorkbookImpl)
    CollectionBaseEx<ExternWorkbookImpl>.OnSetComplete(int, ExternWorkbookImpl, ExternWorkbookImpl)
    CollectionBaseEx<ExternWorkbookImpl>.Parent
    CollectionBaseEx<ExternWorkbookImpl>.QuietMode
    CollectionBaseEx<ExternWorkbookImpl>.Removed
    CollectionBaseEx<ExternWorkbookImpl>.Removing
    CollectionBaseEx<ExternWorkbookImpl>.Set
    CollectionBaseEx<ExternWorkbookImpl>.SetParent(object)
    CollectionBaseEx<ExternWorkbookImpl>.Setting
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class ExternBookCollection : CollectionBaseEx<ExternWorkbookImpl>, IList<ExternWorkbookImpl>, ICollection<ExternWorkbookImpl>, IEnumerable<ExternWorkbookImpl>, IEnumerable, IParentApplication, ICloneParent

    Constructors

    ExternBookCollection(IApplication, object)

    Creates collection with specified Application and Parent.

    Declaration
    public ExternBookCollection(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Application object for the collection.

    object parent

    Parent object for the collection.

    Properties

    this[int]

    Returns single extern workbook from the collection.

    Declaration
    public ExternWorkbookImpl this[int index] { get; }
    Parameters
    Type Name Description
    int index
    Property Value
    Type
    ExternWorkbookImpl

    this[string]

    Returns single extern workbook from the collection.

    Declaration
    public ExternWorkbookImpl this[string strUrl] { get; }
    Parameters
    Type Name Description
    string strUrl
    Property Value
    Type
    ExternWorkbookImpl

    ParentWorkbook

    Returns parent workbook. Read-only.

    Declaration
    public WorkbookImpl ParentWorkbook { get; }
    Property Value
    Type
    WorkbookImpl

    Methods

    Add(ExternWorkbookImpl)

    Adds workbook into collection.

    Declaration
    public int Add(ExternWorkbookImpl book)
    Parameters
    Type Name Description
    ExternWorkbookImpl book

    Book to add.

    Returns
    Type Description
    int

    Index of the new workbook.

    Add(string)

    Adds new workbook into collection

    Declaration
    public int Add(string fileName)
    Parameters
    Type Name Description
    string fileName

    Workbook to add.

    Returns
    Type Description
    int

    Index of the new workbook.

    Add(string, bool)

    Adds new workbook into collection

    Declaration
    public int Add(string fileName, bool bAddInFunctions)
    Parameters
    Type Name Description
    string fileName

    Workbook to add.

    bool bAddInFunctions
    Returns
    Type Description
    int

    Index of the new workbook.

    Add(string, string, List<string>, string[])

    Declaration
    public int Add(string filePath, string fileName, List<string> sheets, string[] names)
    Parameters
    Type Name Description
    string filePath
    string fileName
    List<string> sheets
    string[] names
    Returns
    Type
    int

    AddCopy(ExternBookCollection)

    Copies subbook collection.

    Declaration
    public Dictionary<int, int> AddCopy(ExternBookCollection subBooks)
    Parameters
    Type Name Description
    ExternBookCollection subBooks

    Represents parent subbook collection.

    Returns
    Type Description
    Dictionary<int, int>

    Returns sub book indexes hash. Key - old indexes; Value - new indexes.

    AddDDEFile(string)

    Adds new workbook into collection

    Declaration
    public int AddDDEFile(string fileName)
    Parameters
    Type Name Description
    string fileName

    Workbook to add.

    Returns
    Type Description
    int

    Index of the new workbook.

    ContainsExternName(string)

    Checks whether any of books in this collection contains extern name.

    Declaration
    public bool ContainsExternName(string strName)
    Parameters
    Type Name Description
    string strName

    Name to search.

    Returns
    Type Description
    bool

    True if name was found; false otherwise.

    ContainsExternName(string, ref int, ref int)

    Checks whether any of books in this collection contains extern name.

    Declaration
    public bool ContainsExternName(string strName, ref int iBookIndex, ref int iNameIndex)
    Parameters
    Type Name Description
    string strName

    Name to search.

    int iBookIndex

    Output extern workbook index.

    int iNameIndex

    Output name index.

    Returns
    Type Description
    bool

    True if name was found; false otherwise.

    GetBookByShortName(string)

    Returns extern workbook with specified short name.

    Declaration
    public ExternWorkbookImpl GetBookByShortName(string strShortName)
    Parameters
    Type Name Description
    string strShortName

    Short name to find.

    Returns
    Type Description
    ExternWorkbookImpl

    Extern workbook that corresponds to the specified short name; or Null if there isn't such workbook.

    GetNameIndexes(string, out int)

    Returns index of the extern name.

    Declaration
    public int GetNameIndexes(string strName, out int iRefIndex)
    Parameters
    Type Name Description
    string strName

    Name to search.

    int iRefIndex

    Reference index.

    Returns
    Type Description
    int

    Returns index to extern workbook containing required name.

    InsertSelfSupbook()

    Inserts SupbookRecord describing this workbook.

    Declaration
    public int InsertSelfSupbook()
    Returns
    Type Description
    int

    Index to the SupBookRecord that describes current workbook.

    OnInsertComplete(int, ExternWorkbookImpl)

    Declaration
    protected override void OnInsertComplete(int index, ExternWorkbookImpl value)
    Parameters
    Type Name Description
    int index
    ExternWorkbookImpl value
    Overrides
    CollectionBaseEx<ExternWorkbookImpl>.OnInsertComplete(int, ExternWorkbookImpl)

    Parse(BiffReader, IDecryptor)

    Extracts extern workbooks from the BiffReader.

    Declaration
    [CLSCompliant(false)]
    public void Parse(BiffReader reader, IDecryptor decryptor)
    Parameters
    Type Name Description
    BiffReader reader

    Reader to extract records from.

    IDecryptor decryptor

    Object used to decrypt encrypted records.

    Parse(BiffRecordRaw[], int)

    Parses array of biff records.

    Declaration
    [CLSCompliant(false)]
    public int Parse(BiffRecordRaw[] arrData, int iOffset)
    Parameters
    Type Name Description
    BiffRecordRaw[] arrData

    Array to parse.

    int iOffset

    Offset to collection data.

    Returns
    Type Description
    int

    Offset value after parsing all workbooks.

    Serialize(OffsetArrayList)

    Serializes collection of external workbooks as biff records.

    Declaration
    [CLSCompliant(false)]
    public void Serialize(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    OffsetArrayList to serialize into.

    Implements

    IList<T>
    ICollection<T>
    IEnumerable<T>
    IEnumerable
    IParentApplication
    ICloneParent

    Extension Methods

    CalcEngineHelper.ToArray<T>(IEnumerable<T>)
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved