xlsworksheetscollection-ag凯发旗舰厅

com.spire.xls.core.spreadsheet.collections
class xlsworksheetscollection

java.lang.object
  com.spire.ms.system.collections.collectionbase
      
          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 
implements iworksheets

a collection of all the worksheet objects in the specified or active workbook. each worksheet object represents a worksheet.

xlsworksheetscollection

public xlsworksheetscollection(java.lang.object parent)

creates a collection and sets its application and parent properties.

parameters:

parent - parent object for the collection.

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.