public interface Workbook
Modifier and Type | Method and Description |
---|---|
void |
deleteWorksheet()
Deletes the active worksheet
|
void |
deleteWorksheet(int index)
Deletes the worksheet in the workbook at the given index
|
void |
deleteWorksheet(String sheetNameOrSheetId)
Deletes the worksheet from the given name
|
String |
getName()
Returns the name of this workbook.
|
Range |
getRange(int row,
int column)
Returns the range with the given row and column from the active worksheet.
|
Range |
getRange(int sheetIndex,
int row,
int column)
Returns the range with the given row and column from the given sheet
index.
|
Range |
getRange(int row,
int column,
int numRows,
int numColumns)
Returns the range with the given row and column with the given number
of the rows and columns from the active worksheet.
|
Range |
getRange(int sheetIndex,
int row,
int column,
int numRows,
int numColumns)
Returns the range with the given row and column with the given number
of the rows and columns of the worksheet at the given sheet index.
|
Range |
getRange(int sheetIndex,
String a1Notation)
Returns the range with the given A1 notation or R1C1 notation from the
given sheet index.
|
Range |
getRange(String a1Notation)
Returns the range with the given A1 notation or R1C1 notation from the active
worksheet.
|
Range |
getRange(String sheetNameOrSheetId,
int row,
int column)
Returns the range with the given row and column from the given sheet
name or id.
|
Range |
getRange(String sheetNameOrSheetIndex,
int row,
int column,
int numRows,
int numColumns)
Returns the range with the given row and column with the given number
of the rows and columns of the worksheet with the given sheet name or id.
|
Range |
getRange(String sheetNameOrSheetId,
String a1Notation)
Returns the range with the given A1 notation or R1C1 notation from the
given sheet name or id.
|
int |
getSheetsCount()
Returns the count of the worksheets in this workbook.
|
Spreadsheet |
getSpreadsheet()
Returns the spreadsheet client which holds this workbook.
|
Worksheet |
getWorksheet()
Returns the active worksheet from the remote server.
|
Worksheet |
getWorksheet(int index)
Returns the worksheet by the given index from the remote server.
|
Worksheet |
getWorksheet(String name)
Returns the worksheet by the given name from the remote server.
|
Worksheet |
insertWorksheet()
Inserts a new sheet in the workbook, with a default name.
|
Worksheet |
insertWorksheet(int index)
Inserts a new sheet in the workbook at the given index, with a default name.
|
Worksheet |
insertWorksheet(String sheetNameOrSheetId)
Inserts a new sheet in the workbook, with a given name.
|
void |
setActiveWorksheet(int index)
Makes the active worksheet from the given sheet index.
|
void |
setActiveWorksheet(String sheetNameOrSheetId)
Makes the active worksheet from the given name.
|
Spreadsheet getSpreadsheet()
Worksheet getWorksheet()
Worksheet getWorksheet(int index)
Worksheet getWorksheet(String name)
Range getRange(String a1Notation)
a1Notation
- Range getRange(String sheetNameOrSheetId, String a1Notation)
Range getRange(int sheetIndex, String a1Notation)
Range getRange(int row, int column)
row
- the starting row index of the rangecolumn
- the starting column index of the range.Range getRange(String sheetNameOrSheetId, int row, int column)
sheetNameOrSheetId
- sheet name or idrow
- the starting row index of the rangecolumn
- the starting column index of the range.Range getRange(int sheetIndex, int row, int column)
sheetIndex
- sheet indexrow
- the starting row index of the rangecolumn
- the starting column index of the range.Range getRange(int row, int column, int numRows, int numColumns)
row
- the starting row index of the rangecolumn
- the starting column index of the rangenumRows
- the number of the rowsnumColumns
- the number of the columnsRange getRange(String sheetNameOrSheetIndex, int row, int column, int numRows, int numColumns)
sheetNameOrSheetIndex
- sheet name or id.row
- the starting row index of the rangecolumn
- the starting column index of the rangenumRows
- the number of the rowsnumColumns
- the number of the columnsRange getRange(int sheetIndex, int row, int column, int numRows, int numColumns)
sheetIndex
- sheet indexrow
- the starting row index of the rangecolumn
- the starting column index of the rangenumRows
- the number of the rowsnumColumns
- the number of the columnsString getName()
int getSheetsCount()
void deleteWorksheet()
void deleteWorksheet(String sheetNameOrSheetId)
void deleteWorksheet(int index)
Worksheet insertWorksheet()
Worksheet insertWorksheet(String sheetNameOrSheetId)
Worksheet insertWorksheet(int index)
void setActiveWorksheet(String sheetNameOrSheetId)
sheetNameOrSheetId
- void setActiveWorksheet(int index)
index
- Copyright © 2018. All rights reserved.