|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
System.Objectxl.Workbook
Represents a Workbook. Contains the various factory methods and provides a variety of accessors which provide access to the work sheets.
Method Summary | |
abstract void |
close()
Closes this workbook, and frees makes any memory allocated available for garbage collection |
static WritableWorkbook |
createWorkbook(System.IO.FileInfo file)
Creates a writable workbook with the given file name |
static WritableWorkbook |
createWorkbook(System.IO.FileInfo file,
Workbook in)
Creates a writable workbook with the given filename as a copy of the workbook passed in. |
static WritableWorkbook |
createWorkbook(System.IO.FileInfo file,
WorkbookSettings ws)
Creates a writable workbook with the given file name |
static WritableWorkbook |
createWorkbook(System.IO.FileInfo
file, Workbook in,
WorkbookSettings ws)
Creates a writable workbook with the given filename as a copy of the workbook passed in. |
static WritableWorkbook |
createWorkbook(System.IO.Stream os)
Creates a writable workbook. |
static WritableWorkbook |
createWorkbook(System.IO.Stream os,
Workbook in)
Creates a writable workbook as a copy of the workbook passed in. |
static WritableWorkbook |
createWorkbook(System.IO.Stream os,
WorkbookSettings ws)
Creates a writable workbook. |
static WritableWorkbook |
createWorkbook(System.IO.Stream os,
Workbook in,
WorkbookSettings ws)
Creates a writable workbook as a copy of the workbook passed in. |
abstract Range[] |
findByName(System.String name)
Gets the named range from this workbook. |
abstract Cell |
findCellByName(System.String name)
Gets the named cell from this workbook. |
abstract Cell |
getCell(System.String loc)
Returns the cell for the specified location eg. |
abstract int |
getNumberOfSheets()
Returns the number of sheets in this workbook |
abstract System.String[] |
getRangeNames()
Gets the named ranges |
abstract Sheet |
getSheet(int index)
Gets the specified sheet within this workbook As described in the accompanying technical notes, each call to getSheet forces a reread of the sheet (for memory reasons). |
abstract Sheet |
getSheet(System.String name)
Gets the sheet with the specified name from within this workbook. |
abstract System.String[] |
getSheetNames()
Gets the sheet names |
abstract Sheet[] |
getSheets()
Gets the sheets within this workbook. |
static System.String |
getVersion()
Accessor for the software version |
static Workbook |
getWorkbook(System.IO.FileInfo file)
A factory method which takes in an excel file and reads in the contents. |
static Workbook |
getWorkbook(System.IO.FileInfo file,
WorkbookSettings ws)
A factory method which takes in an excel file and reads in the contents. |
static Workbook |
getWorkbook(System.IO.Stream is)
A factory method which takes in an excel file and reads in the contents. |
static Workbook |
getWorkbook(System.IO.Stream is,
WorkbookSettings ws)
A factory method which takes in an excel file and reads in the contents. |
abstract boolean |
isProtected()
Determines whether the sheet is protected |
Methods inherited from class System.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public abstract Sheet[] getSheets()
public abstract System.String[] getSheetNames()
public abstract Sheet getSheet(int index) throws System.ArgumentOutofRangeException
index
- the zero based index of the reQuired
sheet System.ArgumentOutofRangeException
public abstract Sheet getSheet(System.String name)
name
- the sheet name public static System.String getVersion()
public abstract int getNumberOfSheets()
public abstract Cell findCellByName(System.String name)
name
- the name of the cell/range to search for public abstract Cell getCell(System.String loc)
loc
- the cell to retrieve public abstract Range[] findByName(System.String name)
name
- the name of the cell/range to search for public abstract System.String[] getRangeNames()
public abstract boolean isProtected()
public abstract void close()
public static Workbook getWorkbook(System.IO.FileInfo file) throws System.Exception, xl.read.biff.BiffException
file
- the excel workbook to parse System.Exception
xl.read.biff.BiffException
public static Workbook getWorkbook(System.IO.FileInfo file, WorkbookSettings ws) throws System.Exception, xl.read.biff.BiffException
file
- the excel 97 spreadsheet to parsews
- the settings for the workbook System.Exception
xl.read.biff.BiffException
public static Workbook getWorkbook(System.IO.Stream is) throws System.Exception, xl.read.biff.BiffException
is
- an open stream which is the the excel 97
spreadsheet to parse System.Exception
xl.read.biff.BiffException
public static Workbook getWorkbook(System.IO.Stream is, WorkbookSettings ws) throws System.Exception, xl.read.biff.BiffException
is
- an open stream which is the the excel 97
spreadsheet to parsews
- the settings for the workbook System.Exception
xl.read.biff.BiffException
public static WritableWorkbook createWorkbook(System.IO.FileInfo file) throws System.Exception
file
- the workbook to copy System.Exception
public static WritableWorkbook createWorkbook(System.IO.FileInfo file, WorkbookSettings ws) throws SYstem.Exception
file
- the file to copy fromws
-
the global workbook settings System.Exception
public static WritableWorkbook createWorkbook(System.IO.FileInfo file, Workbook in) throws System.Exception
file
- the output file for the copyin
- the workbook to copy System.Exception
public static WritableWorkbook createWorkbook(System.IO.FileInfo file, Workbook in, WorkbookSettings ws) throws System.Exception
file
- the output file for the copyin
- the workbook to copyws
- the configuration for this workbook System.Exception
public static WritableWorkbook createWorkbook(System.IO.Stream os, Workbook in) throws System.Exception
os
- the stream to write toin
- the
workbook to copy System.Exception
public static WritableWorkbook createWorkbook(System.IO.Stream os, Workbook in, WorkbookSettings ws) throws System.Exception
os
- the output stream to write toin
- the workbook to copyws
- the configuration for this workbook System.Exception
public static WritableWorkbook createWorkbook(System.IO.Stream os) throws System.Exception
os
- the output stream System.Exception
public static WritableWorkbook createWorkbook(System.IO.Stream os, WorkbookSettings ws) throws System.Exception
os
- the output streamws
- the
configuration for this workbook System.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |