Class ExternBookCollection
Collection of external workbooks in the worksheet.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class ExternBookCollection : CollectionBaseEx<ExternWorkbookImpl>, IList<ExternWorkbookImpl>, ICollection<ExternWorkbookImpl>, IEnumerable<ExternWorkbookImpl>, IEnumerable, IParentApplication, ICloneParentConstructors
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. |
| System.Object | parent | Parent object for the collection. |
Properties
Item[Int32]
Returns single extern workbook from the collection.
Declaration
public ExternWorkbookImpl this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| ExternWorkbookImpl |
Item[String]
Returns single extern workbook from the collection.
Declaration
public ExternWorkbookImpl this[string strUrl] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.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 |
|---|---|
| System.Int32 | Index of the new workbook. |
Add(String)
Adds new workbook into collection
Declaration
public int Add(string fileName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fileName | Workbook to add. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index of the new workbook. |
Add(String, Boolean)
Adds new workbook into collection
Declaration
public int Add(string fileName, bool bAddInFunctions)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fileName | Workbook to add. |
| System.Boolean | bAddInFunctions |
Returns
| Type | Description |
|---|---|
| System.Int32 | 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 |
|---|---|---|
| System.String | filePath | |
| System.String | fileName | |
| System.Collections.Generic.List<System.String> | sheets | |
| System.String[] | names |
Returns
| Type |
|---|
| System.Int32 |
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 |
|---|---|
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | 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 |
|---|---|---|
| System.String | fileName | Workbook to add. |
Returns
| Type | Description |
|---|---|
| System.Int32 | 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 |
|---|---|---|
| System.String | strName | Name to search. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if name was found; false otherwise. |
ContainsExternName(String, ref Int32, ref Int32)
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 |
|---|---|---|
| System.String | strName | Name to search. |
| System.Int32 | iBookIndex | Output extern workbook index. |
| System.Int32 | iNameIndex | Output name index. |
Returns
| Type | Description |
|---|---|
| System.Boolean | 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 |
|---|---|---|
| System.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 Int32)
Returns index of the extern name.
Declaration
public int GetNameIndexes(string strName, out int iRefIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strName | Name to search. |
| System.Int32 | iRefIndex | Reference index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns index to extern workbook containing required name. |
InsertSelfSupbook()
Inserts SupbookRecord describing this workbook.
Declaration
public int InsertSelfSupbook()Returns
| Type | Description |
|---|---|
| System.Int32 | Index to the SupBookRecord that describes current workbook. |
OnInsertComplete(Int32, ExternWorkbookImpl)
Declaration
protected override void OnInsertComplete(int index, ExternWorkbookImpl value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | |
| ExternWorkbookImpl | value |
Overrides
Parse(BiffRecordRaw[], Int32)
Parses array of biff records.
Declaration
public int Parse(BiffRecordRaw[] arrData, int iOffset)Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw[] | arrData | Array to parse. |
| System.Int32 | iOffset | Offset to collection data. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Offset value after parsing all workbooks. |
Parse(BiffReader, IDecryptor)
Extracts extern workbooks from the BiffReader.
Declaration
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. |
Serialize(OffsetArrayList)
Serializes collection of external workbooks as biff records.
Declaration
public void Serialize(OffsetArrayList records)Parameters
| Type | Name | Description |
|---|---|---|
| OffsetArrayList | records | OffsetArrayList to serialize into. |