public interface Spreadsheet extends TransientObject
Spreadsheet
object returned by SpreadsheetManager.open(nxopen.SpreadsheetManager.Sheettype, java.lang.String)
.
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears the contents of the current worksheet.
|
void |
delete(int start1,
int end1,
int sheet,
int operation)
Deletes (clears) one or more rows/columns of data from a worksheet.
|
void |
deleteSheets(int sheet,
int count)
Deletes specified number of sheets beginning with the specified sheet
(from the current worksheet, if no sheet is specified).
|
void |
eraseRange(int row0,
int col0,
int row1,
int col1,
int sheet0,
int sheet1)
Clears the contents of the specified range
License requirements: None. |
SpreadsheetCellData |
evaluateCell(int row,
int col,
int sheet)
Returns the evaluated value of a cell.
|
SpreadsheetCellData |
getFormula(int row,
int col,
int sheet)
Retrieves a formula from a cell.
|
int[] |
getNamedRange(String rangename)
Resolves the named reference and returns the range of cells that are named
This method returns a list, of the following format:
Start Row,
Start Column,
End Row,
End Column,
Start Sheet Number,
End Sheet Number
of the named reference.
|
SpreadsheetCellData |
getNumber(int row,
int col,
int sheet)
Retrieves a numeric value from a cell.
|
int |
getNumberOfSheets()
Returns the total number of sheets in the spreadsheet
License requirements: None. |
String[] |
getSheetNames()
Returns list of existing sheet names in the spreadsheet.
|
int |
getSheetNumber()
Returns the current work sheet number of the spreadsheet.
|
int |
getSheetNumberOfName(String sheetname)
Returns sheet number of the sheet with given name.
|
SpreadsheetCellData |
getString(int row,
int col,
int sheet)
Returns the String in the cell
License requirements: None. |
SpreadsheetCellData |
getValue(int row,
int col,
int sheet)
Returns a number, string or formula depending on the contents of the cell.
|
void |
insertSheets(int sheet,
int count)
Inserts specified number of sheets before the specified sheet (or the
current work sheet if no sheet is specified).
|
void |
recalculate()
Recalculates the spreadsheet.
|
void |
save()
Saves the spreadsheet in the part file.
|
void |
setFormula(int row,
int col,
SpreadsheetCellData cellvalue,
int sheet)
Stores a formula into a cell.
|
void |
setNamedRange(String rangename,
int row0,
int col0,
int row1,
int col1,
int sheet)
Defines a name for the Range of cells.
|
void |
setNumber(int row,
int col,
SpreadsheetCellData cellvalue,
int sheet)
Stores a numeric value in the specified cell of the worksheet.
|
void |
setSheetNumber(int sheet)
Sets the worksheet with specified index as current worksheet
License requirements: None. |
void |
setString(int row,
int col,
SpreadsheetCellData cellvalue,
int sheet)
Sets the string in the cell.
|
void |
terminate()
Terminates excel sheet for opened part.
|
_value, dispose, printTestData, printTestData
SpreadsheetCellData getNumber(int row, int col, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellsheet
- Sheet index (current worksheet, if zero is specified)NXException
RemoteException
SpreadsheetCellData getFormula(int row, int col, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellsheet
- Sheet index (current worksheet, if zero is specified)NXException
RemoteException
int getNumberOfSheets() throws NXException, RemoteException
NXException
RemoteException
int getSheetNumber() throws NXException, RemoteException
NXException
RemoteException
int getSheetNumberOfName(String sheetname) throws NXException, RemoteException
sheetname
- Sheet nameNXException
RemoteException
SpreadsheetCellData getString(int row, int col, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellsheet
- Sheet index of the cell (current worksheet, if zero is specified).NXException
RemoteException
SpreadsheetCellData getValue(int row, int col, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellsheet
- Sheet index of the cell (current worksheet, if zero is specified).NXException
RemoteException
void setFormula(int row, int col, SpreadsheetCellData cellvalue, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellcellvalue
- sheet
- Sheet index of the cell (current worksheet, if zero is specified).NXException
RemoteException
void setNumber(int row, int col, SpreadsheetCellData cellvalue, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellcellvalue
- Numeric value to be set in the cell.sheet
- Sheet index (current worksheet, if zero is specified).NXException
RemoteException
void setSheetNumber(int sheet) throws NXException, RemoteException
sheet
- The number to which the current work sheet is to be set.NXException
RemoteException
void setString(int row, int col, SpreadsheetCellData cellvalue, int sheet) throws NXException, RemoteException
row
- Row index of the cell.col
- Column index of the cell.cellvalue
- String to be stored in this cell.sheet
- Sheet index (current worksheet, if zero is specified).NXException
RemoteException
void clear() throws NXException, RemoteException
NXException
RemoteException
void delete(int start1, int end1, int sheet, int operation) throws NXException, RemoteException
start1
- From where the deletion should startend1
- Upto where the rows should be deletedsheet
- The sheet in which deletion should take place.(Current sheet, if no sheet is specified)operation
- 1 for row deletion and 2 for column deletion.NXException
RemoteException
void deleteSheets(int sheet, int count) throws NXException, RemoteException
sheet
- Sheet Number, starting from which sheets are to be deleted.count
- Number of sheets to be deletedNXException
RemoteException
void eraseRange(int row0, int col0, int row1, int col1, int sheet0, int sheet1) throws NXException, RemoteException
row0
- Starting row for rangecol0
- Starting column for rangerow1
- Ending row for rangecol1
- Ending column for rangesheet0
- Sheet number for start of the rangesheet1
- Sheet number for end of the rangeNXException
RemoteException
SpreadsheetCellData evaluateCell(int row, int col, int sheet) throws NXException, RemoteException
row
- Row index of the cellcol
- Column index of the cellsheet
- Sheet index (current worksheet, if zero is specified).NXException
RemoteException
void insertSheets(int sheet, int count) throws NXException, RemoteException
sheet
- Sheet number, before which the sheets are to be inserted.count
- Number of sheets to be inserted.NXException
RemoteException
void terminate() throws NXException, RemoteException
NXException
RemoteException
void save() throws NXException, RemoteException
NXException
RemoteException
void recalculate() throws NXException, RemoteException
NXException
RemoteException
String[] getSheetNames() throws NXException, RemoteException
NXException
RemoteException
int[] getNamedRange(String rangename) throws NXException, RemoteException
rangename
- Range nameNXException
RemoteException
void setNamedRange(String rangename, int row0, int col0, int row1, int col1, int sheet) throws NXException, RemoteException
rangename
- Name to be given to the rangerow0
- Starting row of the table, which is being namedcol0
- Starting column of the table, which is being namedrow1
- Row of the table, upto which the name will applycol1
- Column of the table, upto which the name will applysheet
- Sheet index of the table (current worksheet, if zero is specified).NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.