alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class ExternWorkbookImpl

    Describes external workbook.

    Inheritance
    object
    CommonObject
    ExternWorkbookImpl
    Implements
    IParentApplication
    IDisposable
    ICloneParent
    Inherited Members
    CommonObject.AddReference()
    CommonObject.AppImplementation
    CommonObject.Application
    CommonObject.CheckDisposed()
    CommonObject.Dispose()
    CommonObject.FindParent(object, Type)
    CommonObject.FindParent(object, Type, bool)
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, bool)
    CommonObject.FindParent(Type[])
    CommonObject.FindParents(Type[])
    CommonObject.m_bIsDisposed
    CommonObject.Parent
    CommonObject.ReferenceCount
    CommonObject.ReleaseReference()
    CommonObject.SetParent(object)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation
    Assembly: Syncfusion.XlsIO.NET.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
    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
    int

    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
    bool

    IsOleLink

    Indicates whether the extern workbook is used as ole link

    Declaration
    public bool IsOleLink { get; }
    Property Value
    Type
    bool

    ProgramId

    Gets or sets program id for the ole object.

    Declaration
    public string ProgramId { get; set; }
    Property Value
    Type
    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
    int

    ShortName

    Returns short name of the workbook. Read-only.

    Declaration
    public string ShortName { get; }
    Property Value
    Type
    string

    URL

    Encoded URL without sheet name (for external references).

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

    Workbook

    Returns parent workbook. Read-only.

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

    Methods

    AddName(string)

    Adds external name object to the workbook.

    Declaration
    public void AddName(string name)
    Parameters
    Type Name Description
    string name

    Name of the named range to add.

    AddNames(string[])

    Declaration
    public void AddNames(string[] names)
    Parameters
    Type Name Description
    string[] names

    AddWorksheet(string)

    Adds new worksheet to the collection of worksheets.

    Declaration
    public ExternWorksheetImpl AddWorksheet(string sheetName)
    Parameters
    Type Name Description
    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
    List<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
    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
    object parent

    Parent for the copy of this extern workbook.

    Returns
    Type Description
    object

    Copy of the current extern workbook.

    GetNewIndex(int)

    Get new index for extern name (to remove duplicated extern names).

    Declaration
    public int GetNewIndex(int iNameIndex)
    Parameters
    Type Name Description
    int iNameIndex

    Name index.

    Returns
    Type Description
    int

    Updated name index.

    GetSheetName(int)

    Gets name of the sheet at specified index.

    Declaration
    public string GetSheetName(int index)
    Parameters
    Type Name Description
    int index

    Index of the desired worksheet.

    Returns
    Type Description
    string

    Name of the sheet.

    IndexOf(string)

    Returns index of worksheet in this workbook.

    Declaration
    public int IndexOf(string strSheetName)
    Parameters
    Type Name Description
    string strSheetName

    Sheet name to search for.

    Returns
    Type Description
    int

    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
    CommonObject.OnDispose()

    Parse(BiffReader, IDecryptor)

    Parses extern workbook.

    Declaration
    [CLSCompliant(false)]
    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.

    Parse(BiffRecordRaw[], int)

    Parses extern workbook.

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

    Records array that contains workbook data.

    int iOffset

    Offset to the workbook data.

    Returns
    Type Description
    int

    Offset after reading all necessary data.

    Serialize(OffsetArrayList)

    Saves extern workbook as biff records.

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

    OffsetArrayList to serialize into.

    saveAsHtml(string)

    Save as html

    Declaration
    public void saveAsHtml(string FileName)
    Parameters
    Type Name Description
    string FileName

    Implements

    IParentApplication
    IDisposable
    ICloneParent
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved