Class WorkbooksCollection

A collection of all the Workbook objects that are currently open in the XlsIO application.

Inheritance
System.Object
CollectionBase<IWorkbook>
CollectionBaseEx<IWorkbook>
WorkbooksCollection
Implements
System.Collections.Generic.IList<IWorkbook>
System.Collections.Generic.ICollection<IWorkbook>
System.Collections.Generic.IEnumerable<IWorkbook>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class WorkbooksCollection : CollectionBaseEx<IWorkbook>, IList<IWorkbook>, ICollection<IWorkbook>, IParentApplication, ICloneParent, IWorkbooks, IEnumerable<IWorkbook>, IEnumerable

Constructors

WorkbooksCollection(IApplication, Object)

Creates workbook and sets its Application and Parent properties.

Declaration
public WorkbooksCollection(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 a single object from a collection.

Declaration
public IWorkbook this[int Index] { get; }
Parameters
Type Name Description
System.Int32 Index
Property Value
Type
IWorkbook

Methods

Add()

Creates a new workbook. The new workbook becomes the active workbook. Returns a Workbook object.

Declaration
public IWorkbook Add()
Returns
Type Description
IWorkbook

Added Workbook object.

Add(ExcelVersion)

Creates a new workbook. The new workbook becomes the active workbook.

Declaration
public IWorkbook Add(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version

Excel version - defines file format (excel 97-2003 or excel 2007).
Returns
Type Description
IWorkbook

Added Workbook object.

Add(String)

Creates a new workbook. The new workbook becomes the active workbook. Returns a Workbook object.

Declaration
public IWorkbook Add(string strTemplateFile)
Parameters
Type Name Description
System.String strTemplateFile

File that contains required workbook.
Returns
Type Description
IWorkbook

Added Workbook object.

Add(String, ExcelParseOptions)

Adds workbook to the collection.

Declaration
public IWorkbook Add(string strTemplateFile, ExcelParseOptions options)
Parameters
Type Name Description
System.String strTemplateFile

File to parse.
ExcelParseOptions options

Parse options.
Returns
Type Description
IWorkbook

Created workbook.

Add(String, ExcelParseOptions, ExcelVersion)

Creates a new workbook. The new workbook becomes the active workbook. Returns a Workbook object.

Declaration
public IWorkbook Add(string strTemplateFile, ExcelParseOptions options, ExcelVersion version)
Parameters
Type Name Description
System.String strTemplateFile

File that contains required workbook.
ExcelParseOptions options

Parse options.
ExcelVersion version

Excel version - defines file format (excel 97-2003 or excel 2007).
Returns
Type Description
IWorkbook

Added Workbook object.

Add(String, ExcelVersion)

Creates a new workbook. The new workbook becomes the active workbook. Returns a Workbook object.

Declaration
public IWorkbook Add(string strTemplateFile, ExcelVersion version)
Parameters
Type Name Description
System.String strTemplateFile

File that contains required workbook.
ExcelVersion version

Excel version - defines file format (excel 97-2003 or excel 2007).
Returns
Type Description
IWorkbook

Added Workbook object.

Close()

Closes the object.

Declaration
public void Close()

Create()

Create new empty workbook and make it active.

Declaration
public IWorkbook Create()
Returns
Type Description
IWorkbook

Interface on instance of newly created workbook.

Create(Int32)

Create workbook with specified number of empty worksheets.

Declaration
public IWorkbook Create(int sheetsQuantity)
Parameters
Type Name Description
System.Int32 sheetsQuantity

Number of worksheets to create.
Returns
Type Description
IWorkbook

Interface on instance of created workbook.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

When sheetsQuantity is less than zero.

Create(String[])

Create workbook with names.Length quantity of worksheets. Each worksheet name will be set to corresponding names array element.

Declaration
public IWorkbook Create(string[] names)
Parameters
Type Name Description
System.String[] names

Array of names for each worksheet.
Returns
Type Description
IWorkbook

Interface on instance of created workbook.
Exceptions
Type Condition
System.ArgumentNullException

When names array is NULL.
System.ArgumentException

When names does not contain any value.

Open(Stream)

Read workbook from the stream.

Declaration
public IWorkbook Open(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
Returns
Type Description
IWorkbook

Newly created workbook.

Open(Stream, ExcelOpenType)

Opens a workbook.

Declaration
public IWorkbook Open(Stream stream, ExcelOpenType openType)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelOpenType openType

Represents type of the file for open operation.
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelOpenType, ExcelParseOptions)

Opens a workbook.

Declaration
public IWorkbook Open(Stream stream, ExcelOpenType openType, ExcelParseOptions options)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelOpenType openType

Represents type of the file for open operation.
ExcelParseOptions options
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelOpenType, ExcelVersion)

Opens a workbook.

Declaration
public IWorkbook Open(Stream stream, ExcelOpenType openType, ExcelVersion version)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelOpenType openType

Represents type of the file for open operation.
ExcelVersion version
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelParseOptions)

Read workbook from the stream.

Declaration
public IWorkbook Open(Stream stream, ExcelParseOptions options)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelParseOptions options

Parse options.
Returns
Type Description
IWorkbook

Newly created workbook.

Open(Stream, ExcelParseOptions, Boolean, String)

Opens the specified stream.

Declaration
public IWorkbook Open(Stream stream, ExcelParseOptions options, bool isReadOnly, string password)
Parameters
Type Name Description
System.IO.Stream stream

The stream.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelParseOptions, Boolean, String, ExcelOpenType)

Opens the specified stream.

Declaration
public IWorkbook Open(Stream stream, ExcelParseOptions options, bool isReadOnly, string password, ExcelOpenType openType)
Parameters
Type Name Description
System.IO.Stream stream

The stream.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
ExcelOpenType openType

Represents type of the file for open operation.
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelParseOptions, Boolean, String, ExcelVersion)

Opens the specified stream.

Declaration
public IWorkbook Open(Stream stream, ExcelParseOptions options, bool isReadOnly, string password, ExcelVersion excelVersion)
Parameters
Type Name Description
System.IO.Stream stream

The stream.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
ExcelVersion excelVersion
Returns
Type Description
IWorkbook

Opened workbook.

Open(Stream, ExcelVersion)

Read workbook from the stream.

Declaration
public IWorkbook Open(Stream stream, ExcelVersion version)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelVersion version

Version of the excel file format.
Returns
Type Description
IWorkbook

Newly created workbook.

Open(Stream, ExcelVersion, ExcelParseOptions)

Read workbook from the stream.

Declaration
public IWorkbook Open(Stream stream, ExcelVersion version, ExcelParseOptions options)
Parameters
Type Name Description
System.IO.Stream stream

Stream with workbook's data.
ExcelVersion version

Version of the excel file format.
ExcelParseOptions options
Returns
Type Description
IWorkbook

Newly created workbook.

Open(Stream, String)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(Stream stream, string separator)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.String separator

Denotes separator for the CSV file types.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(Stream, String, ExcelVersion)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(Stream stream, string separator, ExcelVersion version)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.String separator

Denotes separator for the CSV file types.
ExcelVersion version
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(Stream, String, Int32, Int32)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(Stream stream, string separator, int row, int column)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.String separator

Denotes separator for the CSV file types.
System.Int32 row

Number of first row to write.
System.Int32 column

Number of first column to write.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(Stream, String, Int32, Int32, Encoding)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(Stream stream, string separator, int row, int column, Encoding encoding)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.String separator

Denotes separator for the CSV file types.
System.Int32 row

Number of first row to write.
System.Int32 column

Number of first column to write.
System.Text.Encoding encoding

Encoding to use to parse text data.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(Stream, String, Encoding)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(Stream stream, string separator, Encoding encoding)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.String separator

Denotes separator for the CSV file types.
System.Text.Encoding encoding

Encoding to use to parse text data.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(Stream, Encoding)

Opens a Workbook using default separator.

Declaration
public IWorkbook Open(Stream stream, Encoding encoding)
Parameters
Type Name Description
System.IO.Stream stream

Stream to open.
System.Text.Encoding encoding

Encoding to use to parse text data.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(String)

Opens a workbook.

Declaration
public IWorkbook Open(string filename)
Parameters
Type Name Description
System.String filename

File name that contains workbook.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelOpenType)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelOpenType openType)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelOpenType openType

Represents type of the file for open operation.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelOpenType, ExcelParseOptions)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelOpenType openType, ExcelParseOptions options)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelOpenType openType

Represents type of the file for open operation.
ExcelParseOptions options
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelOpenType, ExcelVersion)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelOpenType openType, ExcelVersion version)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelOpenType openType

Represents type of the file for open operation.
ExcelVersion version
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelOpenType, ExcelVersion, ExcelParseOptions)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelOpenType openType, ExcelVersion version, ExcelParseOptions options)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelOpenType openType

Represents type of the file for open operation.
ExcelVersion version
ExcelParseOptions options
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelParseOptions)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelParseOptions options)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelParseOptions options

Parse options.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelParseOptions, Boolean, String)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelParseOptions options, bool isReadOnly, string password)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
Returns
Type Description
IWorkbook

Opened workbook.
Remarks

This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms.

Open(String, ExcelParseOptions, Boolean, String, ExcelOpenType)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelParseOptions options, bool isReadOnly, string password, ExcelOpenType openType)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
ExcelOpenType openType

Represents type of the file for open operation.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelParseOptions, Boolean, String, ExcelVersion)

Opens a workbook.

Declaration
public IWorkbook Open(string fileName, ExcelParseOptions options, bool isReadOnly, string password, ExcelVersion version)
Parameters
Type Name Description
System.String fileName

File name that contains workbook.
ExcelParseOptions options

Parse options.
System.Boolean isReadOnly

Indicates is open book in read - only mode.
System.String password

Represents valid password for opening workbook.
ExcelVersion version

Workbook version.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, ExcelVersion)

Opens a workbook.

Declaration
public IWorkbook Open(string filename, ExcelVersion version)
Parameters
Type Name Description
System.String filename

File name that contains workbook.
ExcelVersion version

Version of the excel file format.
Returns
Type Description
IWorkbook

Opened workbook.

Open(String, String)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(string fileName, string separator)
Parameters
Type Name Description
System.String fileName

Stream to open.
System.String separator

Denotes separator for the CSV file types.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(String, String, Int32, Int32)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(string fileName, string separator, int row, int column)
Parameters
Type Name Description
System.String fileName

File name to open.
System.String separator

Denotes separator for the CSV file types.
System.Int32 row

Number of first row to write.
System.Int32 column

Number of first column to write.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(String, String, Int32, Int32, Encoding)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(string fileName, string separator, int row, int column, Encoding encoding)
Parameters
Type Name Description
System.String fileName

File name to open.
System.String separator

Denotes separator for the CSV file types.
System.Int32 row

Number of first row to write.
System.Int32 column

Number of first column to write.
System.Text.Encoding encoding
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(String, String, Encoding)

Opens a Workbook using separator.

Declaration
public IWorkbook Open(string fileName, string separator, Encoding encoding)
Parameters
Type Name Description
System.String fileName

Stream to open.
System.String separator

Denotes separator for the CSV file types.
System.Text.Encoding encoding

Encoding to use to parse text data.
Returns
Type Description
IWorkbook

Opened WorkBook.

Open(String, Encoding)

Opens a Workbook using default separator.

Declaration
public IWorkbook Open(string fileName, Encoding encoding)
Parameters
Type Name Description
System.String fileName

Stream to open.
System.Text.Encoding encoding

Encoding to use to parse text data.
Returns
Type Description
IWorkbook

Opened WorkBook.

OpenFromXml(Stream, ExcelXmlOpenType)

Read workbook from xml file.

Declaration
public IWorkbook OpenFromXml(Stream stream, ExcelXmlOpenType openType)
Parameters
Type Name Description
System.IO.Stream stream

Path to xml file.
ExcelXmlOpenType openType

Xml open type.
Returns
Type Description
IWorkbook

Returns opened workbook.

OpenFromXml(String, ExcelXmlOpenType)

Read workbook from xml file.

Declaration
public IWorkbook OpenFromXml(string strPath, ExcelXmlOpenType openType)
Parameters
Type Name Description
System.String strPath

Path to xml file.
ExcelXmlOpenType openType

Xml open type.
Returns
Type Description
IWorkbook

Returns opened workbook.

OpenFromXml(XmlReader, ExcelXmlOpenType)

Read workbook from xml stream.

Declaration
public IWorkbook OpenFromXml(XmlReader reader, ExcelXmlOpenType openType)
Parameters
Type Name Description
System.Xml.XmlReader reader

Xml reader.
ExcelXmlOpenType openType

Xml open type.
Returns
Type Description
IWorkbook

Returns opened workbook.

OpenReadOnly(String)

Open new workbook in read-only mode.

Declaration
public IWorkbook OpenReadOnly(string strFileName)
Parameters
Type Name Description
System.String strFileName

File to open.
Returns
Type Description
IWorkbook

Newly created workbook.

OpenReadOnly(String, ExcelOpenType, ExcelParseOptions)

Open new workbook in read-only mode.

Declaration
public IWorkbook OpenReadOnly(string strFileName, ExcelOpenType openType, ExcelParseOptions options)
Parameters
Type Name Description
System.String strFileName

File to open.
ExcelOpenType openType
ExcelParseOptions options

Parse options.
Returns
Type Description
IWorkbook

Newly created workbook.

OpenReadOnly(String, ExcelParseOptions)

Open new workbook in read-only mode.

Declaration
public IWorkbook OpenReadOnly(string strFileName, ExcelParseOptions options)
Parameters
Type Name Description
System.String strFileName

File to open.
ExcelParseOptions options

Parse options.
Returns
Type Description
IWorkbook

Newly created workbook.

OpenReadOnly(String, String)

Open new CSV workbook in read-only mode.

Declaration
public IWorkbook OpenReadOnly(string strFileName, string separator)
Parameters
Type Name Description
System.String strFileName

File to open.
System.String separator

Separator to use.
Returns
Type Description
IWorkbook

Newly created workbook.

PasteWorkbook()

Copies workbook from the clipboard.

Declaration
public IWorkbook PasteWorkbook()
Returns
Type Description
IWorkbook

Pasted workbook.

Implements

System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods