![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.Workbook
public class Workbook
Represents an Excel workbook.
Constructor Summary | |
---|---|
Workbook()
Constructs a workbook object using default settings. |
Method Summary | |
---|---|
Worksheet |
createSheet()
Creates a new worksheet in this workbook. |
Worksheet |
createSheet(java.lang.String sheetName)
Creates a new worksheet in this workbook with the specified sheet name. |
Style |
createStyle()
Creates a new style. |
Worksheet |
getActiveSheet()
Gets the active sheet. |
int |
getActiveSheetIndex()
Gets the active sheet index. |
int |
getCalculationMode()
Returns the calculation mode. |
Style |
getDefaultStyle()
Gets the default style of the workbook. |
Style |
getNamedStyle(java.lang.String styleName)
Gets a style by it's name. |
Style[] |
getNamedStyles()
Gets all named styles within the workbook. |
int |
getNumerOfSheets()
Gets the number of sheets in the workbook. |
Palette |
getPalette()
Gets the palette of the workbook. |
Worksheet |
getSheet(int index)
Returns the sheet at the specified index. |
Worksheet |
getSheet(java.lang.String name)
Gets the sheet with the specified name. |
int |
getSheetIndex(java.lang.String name)
Gets the sheet's index according to its name. |
java.lang.String |
getSheetName(int index)
Returns the name of the sheet at the specified index. |
int |
insertName(java.lang.String text,
java.lang.String refersTo)
Defines a new name. |
boolean |
isCalculateBeforeSave()
Whether workbooks are calculated before they're saved to disk (if the Calculation Mode is set to MANUAL). |
boolean |
isHorizontalScrollBarHidden()
Checks if the horizontal scroll bar is hidden. |
boolean |
isSheetTabBarHidden()
Checks if the sheet tab bar is hidden. |
boolean |
isVerticalScrollBarHidden()
Checks if the vertical scroll bar is hidden. |
void |
moveSheet(int origin,
int dest)
Moves a worksheet. |
void |
read(java.io.InputStream stream)
Reads an Excel file from the given stream. |
void |
read(java.lang.String fileName)
Reads an Excel file from disk. |
void |
removeSheet(int index)
Removes the sheet at the specified index. |
boolean |
removeSheet(java.lang.String sheetName)
Removes the specified sheet from the workbook. |
boolean |
removeSheet(Worksheet sheet)
Removes the specified worksheet. |
void |
setCalculateBeforeSave(boolean calculateBeforeSave)
Sets whether workbooks are calculated before they're saved to disk. |
void |
setCalculationMode(int calculationMode)
Sets the calculation mode. |
void |
setHorizontalScrollBarHidden(boolean isHidden)
Sets the horizontal scroll bar to be hidden or not. |
void |
setSheetTabBarHidden(boolean isHidden)
Sets the sheet tab bar to be hidden or not. |
void |
setVerticalScrollBarHidden(boolean isHidden)
Sets the vertical scroll bar to be hidden or not. |
void |
swapSheet(int idx1,
int idx2)
Swaps the positions of two sheets. |
void |
write(java.io.OutputStream stream)
Writes out the workbook to the given stream. |
void |
write(java.io.OutputStream stream,
int fileFormatType)
Writes out the workbook to the given stream. |
void |
write(java.lang.String fileName)
Writes out the workbook to a file. |
void |
write(java.lang.String fileName,
int fileFormatType)
Writes out the workbook to a file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Workbook()
Method Detail |
---|
public void read(java.io.InputStream stream) throws java.io.IOException
stream
- the stream to read from.
java.io.IOException
- if an I/O error occurs.public void read(java.lang.String fileName) throws java.io.IOException
fileName
- the system-dependent file name.
java.io.IOException
- if an error occurs.public void write(java.io.OutputStream stream) throws java.io.IOException
stream
- the stream to write to.
java.io.IOException
- if an I/O error occurs.public void write(java.io.OutputStream stream, int fileFormatType) throws java.io.IOException
stream
- the stream to write to.fileFormatType
- one of the FileFormatType values whcih specifies the file format.
java.io.IOException
- if an I/O error occurs.public void write(java.lang.String fileName) throws java.io.IOException
fileName
- the system-dependent file name.
java.io.IOException
- if an I/O error occurs.public void write(java.lang.String fileName, int fileFormatType) throws java.io.IOException
fileName
- the system-dependent file name.fileFormatType
- one of the FileFormatType values whcih specifies the file format.
java.io.IOException
- if an I/O error occurs.FileFormatType
public int getNumerOfSheets()
public Worksheet getSheet(int index)
index
- index of the sheet.
java.lang.IllegalArgumentException
- if the index is out of range.public Worksheet getSheet(java.lang.String name)
name
- name of the sheet.
public int getSheetIndex(java.lang.String name)
name
- name of the sheet.
public java.lang.String getSheetName(int index)
index
- index of the sheet.
java.lang.IllegalArgumentException
- if the index is out of range.public Worksheet createSheet()
public Worksheet createSheet(java.lang.String sheetName)
sheetName
- name of the worksheet.
public void swapSheet(int idx1, int idx2)
idx1
- index of the first sheetidx2
- index of the second sheet
java.lang.IllegalArgumentException
- if any of the positions is out of range.public void moveSheet(int origin, int dest)
origin
- the original index of the sheet.dest
- the new index of the sheet.
java.lang.IllegalArgumentException
- if any of the indexes is out of range.public void removeSheet(int index)
index
- index of the sheet.
java.lang.IllegalArgumentException
- if index is out of range.public boolean removeSheet(Worksheet sheet)
sheet
- the sheet to remove.
public boolean removeSheet(java.lang.String sheetName)
sheetName
- name of the sheet to remove
public Style getDefaultStyle()
public Style createStyle()
public Style getNamedStyle(java.lang.String styleName)
styleName
- name of the style.
public Style[] getNamedStyles()
public boolean isHorizontalScrollBarHidden()
public boolean isVerticalScrollBarHidden()
public boolean isSheetTabBarHidden()
public void setHorizontalScrollBarHidden(boolean isHidden)
isHidden
- true for hidden; false otherwise.public void setVerticalScrollBarHidden(boolean isHidden)
isHidden
- true for hidden; false otherwise.public void setSheetTabBarHidden(boolean isHidden)
isHidden
- true for hidden; false otherwise.public int getActiveSheetIndex()
public Worksheet getActiveSheet()
public Palette getPalette()
public boolean isCalculateBeforeSave()
public void setCalculateBeforeSave(boolean calculateBeforeSave)
calculateBeforeSave
- whether workbooks are calculated before they're saved to disk.public int getCalculationMode()
setCalculationMode(int)
public void setCalculationMode(int calculationMode)
calculationMode
- calculation mode.It could be one of the following
values: CalculationMode.AUTOMATIC |
CalculationMode.SEMIAUTOMATIC |
CalculationMode.MANUAL |
java.lang.IllegalArgumentException
- if calculation mode is invalid.public int insertName(java.lang.String text, java.lang.String refersTo) throws java.io.UnsupportedEncodingException
text
- the name text of the user-defined name.refersTo
- the formula that the name is defined to refer to,
beginning with an equal sign.
java.lang.IllegalArgumentException
- if refersTo is null or formulas in the refersTo are unspported.
java.io.UnsupportedEncodingException
- if text contains unsupported encoding.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |