com.grapecity.documents.excel

Interface IWorksheets

All Superinterfaces:

java.lang.Iterable<IWorksheet>

public interface IWorksheets
extends java.lang.Iterable<IWorksheet>

Represents a collection of all the sheets in the workbook.

Method Summary

Modifier and Type	Method and Description
IWorksheet	add() Creates a new worksheet.
IWorksheet	add(SheetType type) Creates a new sheet.
IWorksheet	addAfter(IWorksheet sheet) Creates a new worksheet and inserts it after the specified sheet.
IWorksheet	addBefore(IWorksheet sheet) Creates a new worksheet and inserts it before the specified sheet.
boolean	contains(IWorksheet worksheet) Returns true if the specified Worksheet is contained by the collection of worksheets; otherwise, false is returned.
IWorksheet	get(int index) Gets the worksheet using the index.
IWorksheet	get(java.lang.String name) Gets the worksheet using the name.
IWorksheets	get(java.lang.String[] name) Gets worksheets by names.
int	getCount() Returns the number of objects in the collection.
int	indexOf(IWorksheet worksheet) Returns the zero-based index of the specified worksheet in the collection.
void	select() Selects the object.
void	select(boolean replace) Selects the object.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCount

int getCount()

Returns the number of objects in the collection.

get

IWorksheet get(int index)

Gets the worksheet using the index.

Parameters:

index - The index.

get

IWorksheet get(java.lang.String name)

Gets the worksheet using the name.

Parameters:

name - The worksheet's name.

get

IWorksheets get(java.lang.String[] name)

Gets worksheets by names.

Parameters:

name - An array that represents names of worksheets.

select

void select()

Selects the object.

select

void select(boolean replace)

Selects the object.

Parameters:

replace - Used only with IWorkbook.Worksheets. True to replace the current selection with the specified object. False to extend the current selection to include any previously selected objects and the specified object.

add

IWorksheet add()

Creates a new worksheet. The new worksheet becomes the active sheet.

Returns:

the new worksheet.

add

IWorksheet add(SheetType type)

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

Parameters:

type - The sheet's type.

Returns:

the new worksheet.

addAfter

IWorksheet addAfter(IWorksheet sheet)

Creates a new worksheet and inserts it after the specified sheet.

Parameters:

sheet - The insert sheet.

Returns:

the new worksheet.

addBefore

IWorksheet addBefore(IWorksheet sheet)

Creates a new worksheet and inserts it before the specified sheet.

Parameters:

sheet - The specified sheet index.

Returns:

the new worksheet.

contains

boolean contains(IWorksheet worksheet)

Returns true if the specified Worksheet is contained by the collection of worksheets; otherwise, false is returned.

Parameters:

worksheet - The IWorksheet object.

Returns:

Returns whether the specified worksheet is contained by the collection of worksheets.

indexOf

int indexOf(IWorksheet worksheet)

Returns the zero-based index of the specified worksheet in the collection.

Parameters:

worksheet - The IWorksheet object.

Returns:

Returns the zero-based index of the specified worksheet in the collection.