com.spire.xls.collections
Class WorksheetsCollection

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

All Implemented Interfaces:

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

public class WorksheetsCollection
extends XlsWorksheetsCollection

Represents the WorksheetsCollection.

Method Summary

Worksheet	add(java.lang.String name) Adds a new worksheet.
Worksheet	addCopy(int sheetIndex) Adds copy of worksheet.
Worksheet	addCopy(Worksheet sheet) Adds copy of worksheet.
void	addCopy(WorksheetsCollection sheets) Adding worksheets collection to workbook.
Worksheet	create() Creates a new worksheet.
Worksheet	create(java.lang.String name) Create a new worksheet.
CellRange[]	findAllBool(boolean boolValue) Finds the cell with the input bool.
CellRange[]	findAllDateTime(java.util.Date dateValue) Finds the cell with the input datetime.
CellRange[]	findAllNumber(double doubleValue, boolean formulaValue) Finds the cell with the input double.
CellRange[]	findAllString(java.lang.String stringValue, boolean formula, boolean formulaValue) Finds the cell with the input string.
CellRange	findBool(boolean boolValue) Finds the cell with the input bool.
CellRange	findDateTime(java.util.Date dateValue) Finds the cell with the input date.
CellRange	findNumber(double doubleValue, boolean formulaValue) Finds the cell with the input double.
CellRange	findString(java.lang.String stringValue, boolean formula, boolean formulaValue) Finds the cell with the input string.
Worksheet	get(int Index) Returns a single object from a collection.
Worksheet	get(java.lang.String sheetName) Returns a single object from a collection.
void	remove(Worksheet sheet) Remove worksheet from collection.

Methods inherited from class com.spire.xls.core.spreadsheet.collections.XlsWorksheetsCollection

addCopy, addCopy, addCopy, addCopy, addCopy, addCopyAfter, addCopyAfter, addCopyBefore, addCopyBefore, clear, findAll, findFirst, getUseHashForWorksheetLookup, getUseRangesCache, isRightToLeft, isRightToLeft, move, remove, remove, remove, removeAt

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

getCount, getParent

Method Detail

add

public Worksheet add(java.lang.String name)

Adds a new worksheet.

Overrides:

add in class XlsWorksheetsCollection

Parameters:

name - Worksheet name.

Returns:

Added worksheet.

addCopy

public Worksheet addCopy(int sheetIndex)

Adds copy of worksheet.

Overrides:

addCopy in class XlsWorksheetsCollection

Parameters:

sheetIndex - Sheet index.

Returns:

Added worksheet.

addCopy

public Worksheet addCopy(Worksheet sheet)

Adds copy of worksheet.

Parameters:

sheet - Worksheet to copy.

Returns:

Added worksheet.

addCopy

public void addCopy(WorksheetsCollection sheets)

Adding worksheets collection to workbook.

Parameters:

sheets - Source worksheets collection.

create

public Worksheet create(java.lang.String name)

Create a new worksheet.

Specified by:

create in interface IWorksheets

Overrides:

create in class XlsWorksheetsCollection

Parameters:

name - Worksheet name

Returns:

create

public Worksheet create()

Creates a new worksheet.

Specified by:

create in interface IWorksheets

Overrides:

create in class XlsWorksheetsCollection

Returns:

findAllNumber

public CellRange[] findAllNumber(double doubleValue,
                                 boolean formulaValue)

Finds the cell with the input double.

Parameters:

doubleValue - Double value to search for

formulaValue - Indicates whether to find formula value

Returns:

Found ranges

findAllString

public CellRange[] findAllString(java.lang.String stringValue,
                                 boolean formula,
                                 boolean formulaValue)

Finds the cell with the input string.

Parameters:

stringValue - String value to search for

formula - Indicates whether include formula

formulaValue - Indicates whether include formula value

Returns:

Found ranges

findAllDateTime

public CellRange[] findAllDateTime(java.util.Date dateValue)

Finds the cell with the input datetime.

Parameters:

dateValue - Date value to search for

Returns:

Found ranges

findAllBool

public CellRange[] findAllBool(boolean boolValue)

Finds the cell with the input bool.

Parameters:

boolValue - Bool value to search for

Returns:

Found ranges

findBool

public CellRange findBool(boolean boolValue)

Finds the cell with the input bool.

Parameters:

boolValue - Bool value to search for

Returns:

Found range

findNumber

public CellRange findNumber(double doubleValue,
                            boolean formulaValue)

Finds the cell with the input double.

Parameters:

doubleValue - Double value to search for

formulaValue - Indicates whether includes formula value to search for

Returns:

Found range

findString

public CellRange findString(java.lang.String stringValue,
                            boolean formula,
                            boolean formulaValue)

Finds the cell with the input string.

Parameters:

stringValue - String value to search for

formula - Indicates whether includes formula to search for

formulaValue - Indicates whether includes formula value to search for

Returns:

Found range

findDateTime

public CellRange findDateTime(java.util.Date dateValue)

Finds the cell with the input date.

Parameters:

dateValue - Date value to search for

Returns:

Found range

remove

public void remove(Worksheet sheet)

Remove worksheet from collection.

Parameters:

sheet - Worksheet object.

get

public Worksheet get(int Index)

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

Specified by:

get in interface IWorksheets

Overrides:

get in class XlsWorksheetsCollection

Parameters:

Index -

Returns:

get

public Worksheet get(java.lang.String sheetName)

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

Specified by:

get in interface IWorksheets

Overrides:

get in class XlsWorksheetsCollection

Parameters:

sheetName -

Returns: