com.aspose.cells
Class WorksheetCollection

java.lang.Object
  CollectionBase
      com.aspose.cells.WorksheetCollection

All Implemented Interfaces:

java.lang.Iterable

public abstract class WorksheetCollection 
extends CollectionBase

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.setActiveSheet(1);

public abstract boolean isRefreshAllConnections() / public abstract void setRefreshAllConnections(boolean value)

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

public abstract NameCollection getNames()

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

public abstract int getActiveSheetIndex() / public abstract void setActiveSheetIndex(int value)

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

Sheet index is zero based.

public abstract DxfCollection getDxfs()

Gets the master differential formatting records.

public abstract XmlMapCollection getXmlMaps() / public abstract void setXmlMaps(XmlMapCollection value)

Gets and sets the XML maps in the workbook.

public abstract BuiltInDocumentPropertyCollection getBuiltInDocumentProperties()

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

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:

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

public abstract CustomDocumentPropertyCollection getCustomDocumentProperties()

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

Example:

excel.getWorksheets().getCustomDocumentProperties().add("Checked by", "Jane");

public abstract java.lang.Object getOleSize() / public abstract void setOleSize(java.lang.Object value)

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

Null means no ole size setting.

public abstract ExternalLinkCollection getExternalLinks()

Represents external links in a workbook.

public abstract TableStyleCollection getTableStyles()

Gets TableStyles object.

public int getCount()

public abstract Worksheet get(int index)

Gets the Worksheet element at the specified index.

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

public abstract Worksheet get(java.lang.String sheetName)

Gets the Worksheet element with the specified name.

Parameters:

sheetName - Worksheet name

Returns:

The element with the specified name.

public abstract 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

public abstract 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.

public abstract void sortNames()

Sorts defined names.

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

public abstract Worksheet insert(int index, int sheetType)

Insert a worksheet.

Parameters:

index - The sheet index

sheetType - A SheetType value. The sheet type.

Returns:

Returns an inserted worksheet.

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

Insert a worksheet.

Parameters:

index - The sheet index

sheetType - A SheetType value. The sheet type.

sheetName - The sheet name.

Returns:

Returns an inserted worksheet.

public abstract int add(int type)

Adds a worksheet to the collection.

Parameters:

type - A SheetType value. Worksheet type.

Returns:

Worksheet object index.

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);

public abstract void swapSheet(int sheetIndex1, int sheetIndex2)

Swaps the two sheets.

Parameters:

sheetIndex1 - The first worksheet.

sheetIndex2 - The second worksheet.

public abstract int add()

Adds a worksheet to the collection.

Returns:

Worksheet object index.

public abstract Worksheet add(java.lang.String sheetName)

Adds a worksheet to the collection.

Parameters:

sheetName - Worksheet name

Returns:

Worksheet object.

public abstract void removeAt(java.lang.String name)

Removes the element at a specified name.

Parameters:

name - The name of the element to remove.

public abstract void removeAt(int index)

Removes the element at a specified index.

Parameters:

index - The index value of the element to remove.

public abstract void clear()

Clear all worksheets.

A workbook must contains a worksheet.

public abstract int addCopy(java.lang.String sheetName)
                         throws java.lang.Exception

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

Parameters:

sheetName - Name of source worksheet.

Returns:

Worksheet object index.

public abstract int addCopy(int sheetIndex)
                         throws java.lang.Exception

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

Parameters:

sheetIndex - Index of source worksheet.

Returns:

Worksheet object index.

public abstract 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.

public abstract Range[] getNamedRanges()

Gets all pre-defined named ranges in the spreadsheet.

Returns:

An array of Range objects.

Returns null if the named range does not exist.

public abstract 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.

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

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

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.

public abstract void clearPivottables()

Clears pivot tables from the spreadsheet.

public java.util.Iterator iterator()

public java.lang.Object get(int index)

Reserved for internal use.

public boolean contains(java.lang.Object value)

Reserved for internal use.

public int add(java.lang.Object value)

Reserved for internal use.

public int indexOf(java.lang.Object value)

Reserved for internal use.