|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
System.Objectxl.write.WritableWorkbook
A writable workbook
Field Summary | |
static WritableFont |
ARIAL_10_PT
The default font for Cell formats |
static WritableCellFormat |
HIDDEN_STYLE
A cell format used to hide the cell contents |
static WritableFont |
HYPERLINK_FONT
The font used for hyperlinks |
static WritableCellFormat |
HYPERLINK_STYLE
The style used for hyperlinks |
static WritableCellFormat |
NORMAL_STYLE
The default style for cells |
Method Summary | |
abstract void |
addNameArea(System.String name,
WritableSheet sheet,
int firstCol,
int firstRow,
int lastCol,
int lastRow)
Add new named area to this workbook with the given information. |
abstract void |
close()
Closes this workbook, and makes any memory allocated available for garbage collection. |
void |
copy(Workbook w)
Deprecated. Copying now occurs implicitly as part of the overloaded factory method Workbook.createWorkbood |
abstract void |
copySheet(int s,
System.String name,
int index)
Copy sheet within the same workbook. |
abstract void |
copySheet(System.String s,
System.String name,
int index)
Copies the specified sheet and places it at the index specified by the parameter |
abstract WritableSheet |
createSheet(System.String name,
int index)
Creates, and returns a worksheet at the specified position with the specified name If the index specified is less than or equal to zero, the new sheet is created at the beginning of the workbook. |
abstract Range[] |
findByName(System.String name)
Gets the named range from this workbook. |
abstract WritableCell |
findCellByName(System.String name)
Gets the named cell from this workbook. |
abstract int |
getNumberOfSheets()
Returns the number of sheets in this workbook |
abstract System.String[] |
getRangeNames()
Gets the named ranges |
abstract WritableSheet |
getSheet(int index)
Gets the specified sheet within this workbook |
abstract WritableSheet |
getSheet(System.String name)
Gets the sheet with the specified name from within this workbook |
abstract System.String[] |
getSheetNames()
Gets the sheet names |
abstract WritableSheet[] |
getSheets()
Gets the sheets within this workbook. |
abstract WritableCell |
getWritableCell(System.String loc)
Returns the cell for the specified location eg. |
abstract WritableSheet |
importSheet(System.String name,
int index,
Sheet s)
Imports a sheet from a different workbook. |
abstract WritableSheet |
moveSheet(int fromIndex,
int toIndex)
Moves the specified sheet within this workbook to another index position. |
abstract void |
removeRangeName(System.String name)
Removes the specified named range from the workbook. |
abstract void |
removeSheet(int index)
Removes the sheet at the specified index from this workbook |
abstract void |
setColorRGB(Color c,
int r,
int g,
int b)
Sets the RGB value for the specified color for this workbook |
abstract void |
setOutputFile(System.IO.FileInfo fileName)
Sets a new output file. |
abstract void |
setProtected(boolean prot)
Indicates whether or not this workbook is protected |
abstract void |
write()
Writes out the data held in this workbook in Excel format |
Methods inherited from class System.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final WritableFont ARIAL_10_PT
public static final WritableFont HYPERLINK_FONT
public static final WritableCellFormat NORMAL_STYLE
public static final WritableCellFormat HYPERLINK_STYLE
public static final WritableCellFormat HIDDEN_STYLE
Method Detail |
public abstract WritableSheet[] getSheets()
public abstract System.String[] getSheetNames()
public abstract WritableSheet getSheet(int index) throws System.ArgumentOutOfRangeException
index
- the zero based index of the required sheet
public abstract WritableSheet getSheet(System.String name)
name
- the sheet name
public abstract WritableCell getWritableCell(System.String loc)
loc
- the cell to retrieve
public abstract int getNumberOfSheets()
public abstract void close() throws System.Exception, WriteException
System.Exception
WriteException
public abstract WritableSheet createSheet(System.String name, int index)
name
- the sheet nameindex
- the index number at which to insert
public abstract WritableSheet importSheet(System.String name, int index, Sheet s)
name
- the name of the new sheetindex
- the position for the new sheet within this workbook
public abstract void copySheet(int s, System.String name, int index)
s
- the index of the sheet to copyname
- the name of the new sheetindex
- the position of the new sheetpublic abstract void copySheet(System.String s, System.String name, int index)
s
- the name of the sheet to copyname
- the name of the new sheetindex
- the position of the new sheetpublic abstract void removeSheet(int index)
index
- the sheet index to removepublic abstract WritableSheet moveSheet(int fromIndex, int toIndex)
fromIndex
- the zero based index of the required sheettoIndex
- the zero based index of the required sheet
public abstract void write() throws System.Exception
System.Exception
public abstract void setProtected(boolean prot)
prot
- Protected flagpublic abstract void setColorRGB(Color c, int r, int g, int b)
c
- the color whose RGB value is to be overwrittenr
- the red portion to set (0-255)g
- the green portion to set (0-255)b
- the blue portion to set (0-255)public void copy(Workbook w)
w
- the workdoock to copypublic abstract WritableCell findCellByName(System.String name)
name
- the name of the cell/range to search for
public abstract Range[] findByName(System.String name)
name
- the name of the cell/range to search for
public abstract System.String[] getRangeNames()
public abstract void removeRangeName(System.String name)
name
- the name to removepublic abstract void addNameArea(System.String name, WritableSheet sheet, int firstCol, int firstRow, int lastCol, int lastRow)
name
- name to be created.sheet
- sheet containing the namefirstCol
- first column this name refers to.firstRow
- first row this name refers to.lastCol
- last column this name refers to.lastRow
- last row this name refers to.public abstract void setOutputFile(System.IO.FileInfo fileName) throws System.Exception
fileName
- the file name
System.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |