Class ExternWorkbookImpl
Describes external workbook.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class ExternWorkbookImpl : CommonObject, IParentApplication, IDisposable, ICloneParent
Constructors
ExternWorkbookImpl(IApplication, Object)
Declaration
public ExternWorkbookImpl(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | |
System.Object | parent |
Properties
ExternNames
Returns collection of extern names. Read-only.
Declaration
public ExternNamesCollection ExternNames { get; }
Property Value
Type |
---|
ExternNamesCollection |
Index
Gets / sets index of the workbook.
Declaration
public int Index { get; set; }
Property Value
Type |
---|
System.Int32 |
IsAddInFunctions
Indicates whether add-in function names are stored in EXTERNNAME records following this SUPBOOK record.
Declaration
public bool IsAddInFunctions { get; set; }
Property Value
Type |
---|
System.Boolean |
IsOleLink
Indicates whether the extern workbook is used as ole link
Declaration
public bool IsOleLink { get; }
Property Value
Type |
---|
System.Boolean |
ProgramId
Gets or sets program id for the ole object.
Declaration
public string ProgramId { get; set; }
Property Value
Type |
---|
System.String |
SheetNumber
Number of sheet names (if external references) or number of sheets in this document (if internal references).
Declaration
public int SheetNumber { get; set; }
Property Value
Type |
---|
System.Int32 |
ShortName
Returns short name of the workbook. Read-only.
Declaration
public string ShortName { get; }
Property Value
Type |
---|
System.String |
URL
Encoded URL without sheet name (for external references).
Declaration
public string URL { get; set; }
Property Value
Type |
---|
System.String |
Workbook
Returns parent workbook. Read-only.
Declaration
public WorkbookImpl Workbook { get; }
Property Value
Type |
---|
WorkbookImpl |
Worksheets
Returns worksheets collection sorted by index. Read-only.
Declaration
public SortedList<int, ExternWorksheetImpl> Worksheets { get; }
Property Value
Type |
---|
System.Collections.Generic.SortedList<System.Int32, ExternWorksheetImpl> |
Methods
AddName(String)
Adds external name object to the workbook.
Declaration
public void AddName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the named range to add. |
AddNames(String[])
Declaration
public void AddNames(string[] names)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | names |
AddWorksheet(String)
Adds new worksheet to the collection of worksheets.
Declaration
public ExternWorksheetImpl AddWorksheet(string sheetName)
Parameters
Type | Name | Description |
---|---|---|
System.String | sheetName | Name of the worksheet to add. |
Returns
Type | Description |
---|---|
ExternWorksheetImpl | Create worksheet. |
AddWorksheets(List<String>)
Adds new worksheets to the extern workbook.
Declaration
public void AddWorksheets(List<string> sheets)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.String> | sheets | Array that contains worksheet names to add. |
AddWorksheets(String[])
Adds new worksheets to the extern workbook.
Declaration
public void AddWorksheets(string[] sheets)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | sheets | Array that contains worksheet names to add. |
Clone(Object)
Creates copy of the current extern workbook.
Declaration
public object Clone(object parent)
Parameters
Type | Name | Description |
---|---|---|
System.Object | parent | Parent for the copy of this extern workbook. |
Returns
Type | Description |
---|---|
System.Object | Copy of the current extern workbook. |
GetNewIndex(Int32)
Get new index for extern name (to remove duplicated extern names).
Declaration
public int GetNewIndex(int iNameIndex)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iNameIndex | Name index. |
Returns
Type | Description |
---|---|
System.Int32 | Updated name index. |
GetSheetName(Int32)
Gets name of the sheet at specified index.
Declaration
public string GetSheetName(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Index of the desired worksheet. |
Returns
Type | Description |
---|---|
System.String | Name of the sheet. |
IndexOf(String)
Returns index of worksheet in this workbook.
Declaration
public int IndexOf(string strSheetName)
Parameters
Type | Name | Description |
---|---|---|
System.String | strSheetName | Sheet name to search for. |
Returns
Type | Description |
---|---|
System.Int32 | Index of the worksheet in the workbook; -1 if worksheet was not found. |
InsertDefaultWorksheet()
Inserts default worksheet.
Declaration
public void InsertDefaultWorksheet()
OnDispose()
This method is called during dispose operation.
Declaration
protected override void OnDispose()
Overrides
Parse(BiffRecordRaw[], Int32)
Parses extern workbook.
Declaration
public int Parse(BiffRecordRaw[] arrData, int iOffset)
Parameters
Type | Name | Description |
---|---|---|
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw[] | arrData | Records array that contains workbook data. |
System.Int32 | iOffset | Offset to the workbook data. |
Returns
Type | Description |
---|---|
System.Int32 | Offset after reading all necessary data. |
Parse(BiffReader, IDecryptor)
Parses extern workbook.
Declaration
public void Parse(BiffReader reader, IDecryptor decryptor)
Parameters
Type | Name | Description |
---|---|---|
BiffReader | reader | Reader with workbook data. |
IDecryptor | decryptor | Object used to decrypt encrypted records. |
saveAsHtml(String)
Save as html
Declaration
public void saveAsHtml(string FileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | FileName |
Serialize(OffsetArrayList)
Saves extern workbook as biff records.
Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type | Name | Description |
---|---|---|
OffsetArrayList | records | OffsetArrayList to serialize into. |