com.aspose.cells
Class WorksheetCollection

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

All Implemented Interfaces:

java.lang.Iterable

public 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 boolean getHidePivotFieldList() / public void setHidePivotFieldList(boolean value)

Gets whether hide the field list for the PivotTable.

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

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

public NameCollection getNames()

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

public boolean getEnableHTTPCompression() / public void setEnableHTTPCompression(boolean value)

Indicates if http compression is to be used in user's IIS.

Please specify this property to true if http compression is used. NOTE: This property is now obsolete. Instead, please use SaveOptions.EnableHTTPCompression property. This property will be removed 12 months later since February 2012. Aspose apologizes for any inconvenience you may have experienced.

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

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

Sheet index is zero based.

public boolean isMinimized() / public void setMinimized(boolean value)

Represents whether the generated spreadsheet will be opened Minimized.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.IsMinimized property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean isHidden() / public void setHidden(boolean value)

Indicates whether this workbook is hidden.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.IsHidden property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowLeft() / public void setWindowLeft(double value)

The distance from the left edge of the client area to the left edge of the window, in unit of point.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowLeft property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowLeftInch() / public void setWindowLeftInch(double value)

The distance from the left edge of the client area to the left edge of the window. In unit of inch.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowLeftInch property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowLeftCM() / public void setWindowLeftCM(double value)

The distance from the left edge of the client area to the left edge of the window. In unit of centimeter.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowLeftCM property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowTop() / public void setWindowTop(double value)

The distance from the top edge of the client area to the top edge of the window, in unit of point.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowTop property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowTopInch() / public void setWindowTopInch(double value)

The distance from the top edge of the client area to the top edge of the window,in unit of inch.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowTopInch property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowTopCM() / public void setWindowTopCM(double value)

The distance from the top edge of the client area to the top edge of the window,in unit of centimeter.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowTopCM property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowWidth() / public void setWindowWidth(double value)

The width of the window, in unit of point.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowWidth property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowWidthInch() / public void setWindowWidthInch(double value)

The width of the window,in unit of inch.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowWidthInch property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowWidthCM() / public void setWindowWidthCM(double value)

The width of the window,in unit of centimeter.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowWidthCM property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowHeight() / public void setWindowHeight(double value)

The height of the window, in unit of point.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowHeight property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowHeightInch() / public void setWindowHeightInch(double value)

The height of the window,in unit of inch.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowHeightInch property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public double getWindowHeightCM() / public void setWindowHeightCM(double value)

The height of the window,in unit of centimeter.

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.WindowHeightCM property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

public int getSheetTabBarWidth() / public void setSheetTabBarWidth(int value)

Width of worksheet tab bar (in 1/1000 of window width).

NOTE: This member is now obsolete. Instead, please use Workbook.Settings.SheetTabBarWidth property. This property will be removed 12 months later since APRIL 2012. Aspose apologizes for any inconvenience you may have experienced.

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

gets and sets the xml maps in the workbook.

public 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 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 java.lang.Object getOleSize() / public 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 ExternalLinkCollection getExternalLinks()

Represents external links in a workbook.

public TableStyleCollection getTableStyles()

Gets TableStyles object.

public int getCount()

public 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 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 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 com.aspose.cells.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 com.aspose.cells.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 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 void deleteName(java.lang.String definedName)

Deletes a defined name in the workbook.

NOTE: This member is now obsolete. Instead, please use Names.Remove() method. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

definedName - Defined name.

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.

public 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 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 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 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 void swapSheet(int sheetIndex1, int sheetIndex2)

Swaps the two sheets.

Parameters:

sheetIndex1 - The first worksheet.

sheetIndex2 - The second worksheet.

public int add()

Adds a worksheet to the collection.

Returns:

Worksheet object index.

public Worksheet add(java.lang.String sheetName)

Adds a worksheet to the collection.

Parameters:

sheetName - Worksheet name

Returns:

Worksheet object.

public void removeAt(java.lang.String name)

Removes the element at a specified name.

Parameters:

name - The name of the element to remove.

public void removeAt(int index)

Removes the element at a specified index.

Parameters:

index - The index value of the element to remove.

public void clear()

Clear all worksheets.

A workbook must contains a worksheet.

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