com.aspose.cells

Class WorksheetCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.WorksheetCollection

All Implemented Interfaces:

java.lang.Iterable

public class WorksheetCollection
extends CollectionBase

Encapsulates a collection of Range.getWorksheet() objects.

Example

 
         Workbook workbook = new Workbook();
 
         WorksheetCollection sheets = workbook.getWorksheets();
 
         //Add a worksheet
         sheets.add();
 
         //Change the name of a worksheet
         sheets.get(0).setName("First Sheet");
 
         //Set the active sheet to the second worksheet
         sheets.setActiveSheetIndex(1);
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add() Adds a worksheet to the collection.
int	add(int type) Adds a worksheet to the collection.
Worksheet	add(java.lang.String sheetName) Adds a worksheet to the collection.
int	addCopy(int sheetIndex) Adds a worksheet to the collection and copies data from an existed worksheet.
int	addCopy(java.lang.String sheetName) Adds a worksheet to the collection and copies data from an existed worksheet.
void	addCopy(Worksheet[] source, java.lang.String[] destSheetNames) Copy a group of worksheets.
void	clear() Clear all worksheets.
void	clearPivottables() Clears pivot tables from the spreadsheet.
Range	createRange(java.lang.String address, int sheetIndex) Creates a Range object from an address of the range.
UnionRange	createUnionRange(java.lang.String address, int sheetIndex) Creates a Range object from an address of the range.
Worksheet	get(int index) Gets the Range.getWorksheet() element at the specified index.
Worksheet	get(java.lang.String sheetName) Gets the Range.getWorksheet() element with the specified name.
int	getActiveSheetIndex() Represents the index of active worksheet when the spreadsheet is opened.
java.lang.String	getActiveSheetName() Represents the name of active worksheet when the spreadsheet is opened.
BuiltInDocumentPropertyCollection	getBuiltInDocumentProperties() Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.
CustomDocumentPropertyCollection	getCustomDocumentProperties() Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.
DxfCollection	getDxfs() Gets the master differential formatting records.
ExternalLinkCollection	getExternalLinks() Represents external links in a workbook.
Range[]	getNamedRanges() Gets all pre-defined named ranges in the spreadsheet.
Range[]	getNamedRangesAndTables() Gets all pre-defined named ranges in the spreadsheet.
NameCollection	getNames() Gets the collection of all the Name objects in the spreadsheet.
java.lang.Object	getOleSize() Gets displayed size when Workbook file is used as an Ole object.
Range	getRangeByName(java.lang.String rangeName) Gets Range object by pre-defined name.
Range	getRangeByName(java.lang.String rangeName, int currentSheetIndex, boolean includeTable) Gets Range by pre-defined name or table's name
RevisionLogCollection	getRevisionLogs() Represents revision logs.
SensitivityLabelCollection	getSensitivityLabels() Represents all sensitivity labels.
Worksheet	getSheetByCodeName(java.lang.String codeName) Gets the worksheet by the code name.
TableStyleCollection	getTableStyles() Gets getTableStyles() object.
ThreadedCommentAuthorCollection	getThreadedCommentAuthors() Gets the list of threaded comment authors.
WebExtensionCollection	getWebExtensions() Gets the list of task panes.
WebExtensionTaskPaneCollection	getWebExtensionTaskPanes() Gets the list of task panes.
XmlMapCollection	getXmlMaps() Gets the XML maps in the workbook.
Worksheet	insert(int index, int sheetType) Insert a worksheet.
Worksheet	insert(int index, int sheetType, java.lang.String sheetName) Insert a worksheet.
boolean	isRefreshAllConnections() Indicates whether refresh all connections on opening file in MS Excel.
void	refreshAll() Refresh all pivot tables and charts with pivot source.
void	refreshPivotTables() Refreshes all the PivotTables in the Excel file.
boolean	refreshPivotTables(PivotTableRefreshOption option) Refreshes all the PivotTables in the Excel file.
java.lang.String	registerAddInFunction(int id, java.lang.String functionName) Adds addin function into the workbook
int	registerAddInFunction(java.lang.String addInFile, java.lang.String functionName, boolean lib) Adds addin function into the workbook
void	removeAt(int index) Removes the element at a specified index.
void	removeAt(java.lang.String name) Removes the element at a specified name.
void	setActiveSheetIndex(int value) Represents the index of active worksheet when the spreadsheet is opened.
void	setActiveSheetName(java.lang.String value) Represents the name of active worksheet when the spreadsheet is opened.
void	setOleSize(int startRow, int endRow, int startColumn, int endColumn) Sets displayed size when Workbook file is used as an Ole object.
void	setOleSize(java.lang.Object value) Sets displayed size when Workbook file is used as an Ole object.
void	setRefreshAllConnections(boolean value) Indicates whether refresh all connections on opening file in MS Excel.
void	setXmlMaps(XmlMapCollection value) Sets the XML maps in the workbook.
void	sortNames() Sorts the defined names.
void	swapSheet(int sheetIndex1, int sheetIndex2) Swaps the two sheets.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getWebExtensionTaskPanes

public WebExtensionTaskPaneCollection getWebExtensionTaskPanes()

Gets the list of task panes.

getWebExtensions

public WebExtensionCollection getWebExtensions()

Gets the list of task panes.

getThreadedCommentAuthors

public ThreadedCommentAuthorCollection getThreadedCommentAuthors()

Gets the list of threaded comment authors.

isRefreshAllConnections

public boolean isRefreshAllConnections()

Indicates whether refresh all connections on opening file in MS Excel.

setRefreshAllConnections

public void setRefreshAllConnections(boolean value)

Indicates whether refresh all connections on opening file in MS Excel.

createRange

public Range createRange(java.lang.String address,
                int sheetIndex)

Creates a Range object from an address of the range.

Parameters:

address - The address of the range.

sheetIndex - The sheet index.

Returns:

A Range object

createUnionRange

public UnionRange createUnionRange(java.lang.String address,
                          int sheetIndex)

Creates a Range object from an address of the range.

Parameters:

address - The address of the range.

sheetIndex - The sheet index.

Returns:

A Range object

getNames

public NameCollection getNames()

Gets the collection of all the Name objects in the spreadsheet.

get

public Worksheet get(int index)

Gets the Range.getWorksheet() element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public Worksheet get(java.lang.String sheetName)

Gets the Range.getWorksheet() element with the specified name.

Parameters:

sheetName - Worksheet name

Returns:

The element with the specified name.

getSheetByCodeName

public Worksheet getSheetByCodeName(java.lang.String codeName)

Gets the worksheet by the code name.

Parameters:

codeName - Worksheet code name.

Returns:

The element with the specified code name.

getActiveSheetName

public java.lang.String getActiveSheetName()

Represents the name of active worksheet when the spreadsheet is opened.

setActiveSheetName

public void setActiveSheetName(java.lang.String value)

Represents the name of active worksheet when the spreadsheet is opened.

getActiveSheetIndex

public int getActiveSheetIndex()

Represents the index of active worksheet when the spreadsheet is opened.

Remarks

Sheet index is zero based.

setActiveSheetIndex

public void setActiveSheetIndex(int value)

Represents the index of active worksheet when the spreadsheet is opened.

Remarks

Sheet index is zero based.

sortNames

public void sortNames()

Sorts the defined names.

Remarks

If you create a large amount of named ranges in the Excel file, please call this method after all named ranges are created and before saving

insert

public Worksheet insert(int index,
               int sheetType)

Insert a worksheet.

Parameters:

index - The sheet index

sheetType - SheetType. The sheet type.

Returns:

Returns an inserted worksheet.

insert

public Worksheet insert(int index,
               int sheetType,
               java.lang.String sheetName)

Insert a worksheet.

Parameters:

index - The sheet index

sheetType - SheetType. The sheet type.

sheetName - The sheet name.

Returns:

Returns an inserted worksheet.

add

public int add(int type)

Adds a worksheet to the collection.

Example

 
         Workbook workbook = new Workbook();
         workbook.getWorksheets().add(SheetType.CHART);
                Cells cells = workbook.getWorksheets().get(0).getCells();
                cells.get("c2").putValue(5000);
                cells.get("c3").putValue(3000);
                cells.get("c4").putValue(4000);
                cells.get("c5").putValue(5000);
                cells.get("c6").putValue(6000);
                ChartCollection charts = workbook.getWorksheets().get(1).getCharts();
                int chartIndex = charts.add(ChartType.COLUMN, 10,10,20,20);
                Chart chart = charts.get(chartIndex);
                chart.getNSeries().add("Sheet1!C2:C6", true);
 

Parameters:

type - SheetType. Worksheet type.

Returns:

Range.getWorksheet() object index.

swapSheet

public void swapSheet(int sheetIndex1,
             int sheetIndex2)

Swaps the two sheets.

Parameters:

sheetIndex1 - The first worksheet.

sheetIndex2 - The second worksheet.

add

public int add()

Adds a worksheet to the collection.

Returns:

Range.getWorksheet() object index.

add

public Worksheet add(java.lang.String sheetName)

Adds a worksheet to the collection.

Parameters:

sheetName - Worksheet name

Returns:

Range.getWorksheet() object.

registerAddInFunction

public int registerAddInFunction(java.lang.String addInFile,
                        java.lang.String functionName,
                        boolean lib)

Adds addin function into the workbook

Parameters:

addInFile - the file contains the addin functions

functionName - the addin function name

lib - whether the given addin file is in the directory or sub-directory of Workbook Add-In library. This flag takes effect and makes difference when given addInFile is of relative path: true denotes the path is relative to Add-In library and false denotes the path is relative to this Workbook.

Returns:

ID of the data which contains given addin function

registerAddInFunction

public java.lang.String registerAddInFunction(int id,
                                     java.lang.String functionName)

Adds addin function into the workbook

Parameters:

id - ID of the data which contains addin functions, can be got by the first call of registerAddInFunction(String,String,boolean) for the same addin file.

functionName - the addin function name

Returns:

URL of the addin file which contains addin functions

removeAt

public void removeAt(java.lang.String name)

Removes the element at a specified name.

Parameters:

name - The name of the element to remove.

removeAt

public void removeAt(int index)

Removes the element at a specified index.

Overrides:

removeAt in class CollectionBase

Parameters:

index - The index value of the element to remove.

clear

public void clear()

Clear all worksheets.

Remarks

A workbook must contains a worksheet.

Overrides:

clear in class CollectionBase

addCopy

public int addCopy(java.lang.String sheetName)

Adds a worksheet to the collection and copies data from an existed worksheet.

Parameters:

sheetName - Name of source worksheet.

Returns:

Range.getWorksheet() object index.

addCopy

public int addCopy(int sheetIndex)

Adds a worksheet to the collection and copies data from an existed worksheet.

Parameters:

sheetIndex - Index of source worksheet.

Returns:

Range.getWorksheet() object index.

addCopy

public void addCopy(Worksheet[] source,
           java.lang.String[] destSheetNames)

Copy a group of worksheets.

Parameters:

source - The source worksheets.

destSheetNames - The names of the copied sheets.

getDxfs

public DxfCollection getDxfs()

Gets the master differential formatting records.

getRangeByName

public Range getRangeByName(java.lang.String rangeName)

Gets Range object by pre-defined name.

Parameters:

rangeName - Name of range.

Returns:

Range object.

Returns null if the named range does not exist.

getRangeByName

public Range getRangeByName(java.lang.String rangeName,
                   int currentSheetIndex,
                   boolean includeTable)

Gets Range by pre-defined name or table's name

Parameters:

rangeName - Name of range or table's name.

currentSheetIndex - The sheet index. -1 represents global .

includeTable - Indicates whether checking all tables.

Returns:

getNamedRanges

public Range[] getNamedRanges()

Gets all pre-defined named ranges in the spreadsheet.

Returns:

An array of Range objects. If the defined Name's reference is external or has multiple ranges, no Range object will be returned for this Name.

Returns null if the named range does not exist.

getNamedRangesAndTables

public Range[] getNamedRangesAndTables()

Gets all pre-defined named ranges in the spreadsheet.

Returns:

An array of Range objects.

Returns null if the named range does not exist.

getXmlMaps

public XmlMapCollection getXmlMaps()

Gets the XML maps in the workbook.

setXmlMaps

public void setXmlMaps(XmlMapCollection value)

Sets the XML maps in the workbook.

getBuiltInDocumentProperties

public BuiltInDocumentPropertyCollection getBuiltInDocumentProperties()

Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet.

Remarks

A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. The following is the built-in properties name list:

Title

Subject

Author

Keywords

Comments

Template

Last Author

Revision Number

Application Name

Last Print Date

Creation Date

Last Save Time

Total Editing Time

Number of Pages

Number of Words

Number of Characters

Security

Category

Format

Manager

Company

Number of Bytes

Number of Lines

Number of Paragraphs

Number of Slides

Number of Notes

Number of Hidden Slides

Number of Multimedia Clips

Example

 
         Workbook workbook = new Workbook();
         DocumentProperty doc = workbook.getWorksheets().getBuiltInDocumentProperties().get("Author");
         doc.setValue("John Smith");
 

getCustomDocumentProperties

public CustomDocumentPropertyCollection getCustomDocumentProperties()

Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.

Example

 
         Workbook workbook = new Workbook();
         workbook.getWorksheets().getCustomDocumentProperties().add("Checked by", "Jane");
 

getOleSize

public java.lang.Object getOleSize()

Gets displayed size when Workbook file is used as an Ole object.

Remarks

Null means no ole size setting.

setOleSize

public void setOleSize(java.lang.Object value)

Sets displayed size when Workbook file is used as an Ole object.

Remarks

Null means no ole size setting.

setOleSize

public void setOleSize(int startRow,
              int endRow,
              int startColumn,
              int endColumn)

Sets displayed size when Workbook file is used as an Ole object.

Remarks

This method is generally used to adjust display size in ppt file or doc file.

Parameters:

startRow - Start row index.

endRow - End row index.

startColumn - Start column index.

endColumn - End column index.

getExternalLinks

public ExternalLinkCollection getExternalLinks()

Represents external links in a workbook.

getTableStyles

public TableStyleCollection getTableStyles()

Gets getTableStyles() object.

clearPivottables

public void clearPivottables()

Clears pivot tables from the spreadsheet.

getRevisionLogs

public RevisionLogCollection getRevisionLogs()

Represents revision logs.

refreshAll

public void refreshAll()

Refresh all pivot tables and charts with pivot source.

refreshPivotTables

public void refreshPivotTables()

Refreshes all the PivotTables in the Excel file.

refreshPivotTables

public boolean refreshPivotTables(PivotTableRefreshOption option)

Refreshes all the PivotTables in the Excel file.

Parameters:

option - The option for refreshing data source of the pivot tables.

getSensitivityLabels

public SensitivityLabelCollection getSensitivityLabels()

Represents all sensitivity labels.