com.spire.xls.core.spreadsheet.collections
Class XlsWorksheetsCollection

java.lang.Object
  com.spire.ms.System.Collections.CollectionBase
      com.spire.xls.core.spreadsheet.collections.CollectionExtended
          com.spire.xls.core.spreadsheet.collections.XlsWorksheetsCollection

All Implemented Interfaces:

com.spire.ms.System.Collections.ICollection, com.spire.ms.System.Collections.IEnumerable, IWorksheets, java.lang.Iterable

Direct Known Subclasses:

WorksheetsCollection

public class XlsWorksheetsCollection
extends CollectionExtended
implements IWorksheets

A collection of all the Worksheet objects in the specified or active workbook. Each Worksheet object represents a worksheet.

Constructor Summary

XlsWorksheetsCollection(java.lang.Object parent)
Creates a collection and sets its Application and Parent properties.

Method Summary

IWorksheet	add(java.lang.String sheetName) Adds an empty worksheet.
IWorksheet	addCopy(int sheetIndex)
IWorksheet	addCopy(int sheetIndex, WorksheetCopyType flags) Add a copy of the specified worksheet to the worksheet collection.
IWorksheet	addCopy(IWorksheet sheet) Adds copy of worksheet.
void	addCopy(IWorksheets worksheets) Adding worksheets collection to current workbook.
void	addCopy(IWorksheets worksheets, WorksheetCopyType flags) Adding worksheets collection to current workbook.
IWorksheet	addCopy(IWorksheet sheet, WorksheetCopyType flags) Adds a copy of worksheet.
IWorksheet	addCopyAfter(IWorksheet toCopy) Adds copy of sheet to collection after choosed sheet.
IWorksheet	addCopyAfter(IWorksheet toCopy, IWorksheet sheetBefore) Adds copy of sheet to collection before choosed sheet.
IWorksheet	addCopyBefore(IWorksheet toCopy) Adds copy of sheet to collection before choosed sheet.
IWorksheet	addCopyBefore(IWorksheet toCopy, IWorksheet sheetAfter) Adds copy of sheet to collection before choosed sheet.
void	clear()
IWorksheet	create() Create a new worksheet.
IWorksheet	create(java.lang.String name) Create worksheet with specified name.
CellRange[]	findAll(java.lang.String findValue, java.util.EnumSet<FindType> flags, java.util.EnumSet<ExcelFindOptions> findOptions)
IXLSRange	findFirst(java.lang.String findValue, java.util.EnumSet<FindType> flags, java.util.EnumSet<ExcelFindOptions> findOptions)
IWorksheet	get(int Index) Returns a single object from a collection.
IWorksheet	get(java.lang.String sheetName) Returns a single object from a collection.
boolean	getUseHashForWorksheetLookup() Toggles worksheet search algorithm when searching worksheet by name.
boolean	getUseRangesCache() Indicates whether all created range objects should be cached.
boolean	isRightToLeft()
void	isRightToLeft(boolean value)
void	move(int oldIndex, int newIndex) Moves worksheet..
void	remove(int index) Removes specified worksheet from the collection.
void	remove(IWorksheet sheet) Remove specified worksheet from workbook collection.
void	remove(java.lang.String sheetName) Removes specified worksheet from the collection.
void	removeAt(int index) Removes specified worksheet from the collection.

Methods inherited from interface com.spire.xls.core.IWorksheets

getCount, getParent

Constructor Detail

XlsWorksheetsCollection

public XlsWorksheetsCollection(java.lang.Object parent)

Creates a collection and sets its Application and Parent properties.

Parameters:

parent - Parent object for the collection.

Method Detail

get

public IWorksheet get(int Index)

Returns a single object from a collection. Read-only.

Specified by:

get in interface IWorksheets

get

public IWorksheet get(java.lang.String sheetName)

Returns a single object from a collection. Read-only.

Specified by:

get in interface IWorksheets

getUseRangesCache

public boolean getUseRangesCache()

Indicates whether all created range objects should be cached.

Specified by:

getUseRangesCache in interface IWorksheets

getUseHashForWorksheetLookup

public boolean getUseHashForWorksheetLookup()

Toggles worksheet search algorithm when searching worksheet by name.

clear

public void clear()

Overrides:

clear in class com.spire.ms.System.Collections.CollectionBase

create

public IWorksheet create()

Description copied from interface: IWorksheets

Create a new worksheet.

Specified by:

create in interface IWorksheets

Returns:

Reference on created worksheet.

create

public IWorksheet create(java.lang.String name)

Description copied from interface: IWorksheets

Create worksheet with specified name.

Specified by:

create in interface IWorksheets

Parameters:

name - New name of worksheet. Must be unique for collection.

Returns:

Reference on created worksheet.

findAll

public CellRange[] findAll(java.lang.String findValue,
                           java.util.EnumSet<FindType> flags,
                           java.util.EnumSet<ExcelFindOptions> findOptions)

findFirst

public IXLSRange findFirst(java.lang.String findValue,
                           java.util.EnumSet<FindType> flags,
                           java.util.EnumSet<ExcelFindOptions> findOptions)

remove

public void remove(IWorksheet sheet)

Remove specified worksheet from workbook collection.

Specified by:

remove in interface IWorksheets

Parameters:

sheet - Reference on worksheet to remove. When specified sheet is last sheet in the workbook.

remove

public void remove(java.lang.String sheetName)

Removes specified worksheet from the collection.

Specified by:

remove in interface IWorksheets

Parameters:

sheetName - Name of the sheet to remove.

remove

public void remove(int index)

Removes specified worksheet from the collection.

Specified by:

remove in interface IWorksheets

Parameters:

index - Index of the sheet to remove.

removeAt

public void removeAt(int index)

Removes specified worksheet from the collection.

Overrides:

removeAt in class com.spire.ms.System.Collections.CollectionBase

Parameters:

index - Index of the sheet to remove.

addCopyBefore

public IWorksheet addCopyBefore(IWorksheet toCopy)

Adds copy of sheet to collection before choosed sheet.

Specified by:

addCopyBefore in interface IWorksheets

Parameters:

toCopy - Represents worksheet to copy.

Returns:

Returns copied sheet.

addCopyBefore

public IWorksheet addCopyBefore(IWorksheet toCopy,
                                IWorksheet sheetAfter)

Adds copy of sheet to collection before choosed sheet.

Specified by:

addCopyBefore in interface IWorksheets

Parameters:

toCopy - Represents worksheet to copy.

sheetAfter - Represents sheet that, in collection must be after copied sheet.

Returns:

Returns copied sheet.

addCopyAfter

public IWorksheet addCopyAfter(IWorksheet toCopy)

Adds copy of sheet to collection after choosed sheet.

Specified by:

addCopyAfter in interface IWorksheets

Parameters:

toCopy - Represents worksheet to copy.

Returns:

Returns copied sheet.

addCopyAfter

public IWorksheet addCopyAfter(IWorksheet toCopy,
                               IWorksheet sheetBefore)

Adds copy of sheet to collection before choosed sheet.

Specified by:

addCopyAfter in interface IWorksheets

Parameters:

toCopy - Represents worksheet to copy.

sheetBefore - Represents sheet that, in collection must be before copied sheet.

Returns:

Returns copied sheet.

isRightToLeft

public boolean isRightToLeft()

isRightToLeft

public void isRightToLeft(boolean value)

move

public void move(int oldIndex,
                 int newIndex)

Moves worksheet..

Parameters:

oldIndex - Old index.

newIndex - New index.

add

public IWorksheet add(java.lang.String sheetName)

Adds an empty worksheet.

Parameters:

sheetName - Name of the newly created worksheet.

Returns:

Newly created worksheet.

addCopy

public IWorksheet addCopy(int sheetIndex)

addCopy

public IWorksheet addCopy(IWorksheet sheet)

Adds copy of worksheet.

Parameters:

sheet - Worksheet to copy.

Returns:

Copy of worksheet that was added.

addCopy

public IWorksheet addCopy(IWorksheet sheet,
                          WorksheetCopyType flags)

Adds a copy of worksheet.

Parameters:

sheet - Worksheet to copy.

flags - Represetns copy flags.

Returns:

A copy of worksheet that was added.

addCopy

public void addCopy(IWorksheets worksheets)

Adding worksheets collection to current workbook.

Parameters:

worksheets - Source worksheets collection.

addCopy

public void addCopy(IWorksheets worksheets,
                    WorksheetCopyType flags)

Adding worksheets collection to current workbook.

Parameters:

worksheets - Source worksheets collection.

flags - Represents copy option flags.

addCopy

public IWorksheet addCopy(int sheetIndex,
                          WorksheetCopyType flags)

Add a copy of the specified worksheet to the worksheet collection.

Parameters:

sheetIndex - Index of the workbook that should be copied

flags - Represents copy options flags.

Returns:

Returns copied sheet.