Property Detail

• XSpreadsheet activeSheet

• java.lang.Object cellStyle

• java.lang.String formulaOfCell

• XCell propertyValue

• java.lang.Double valueOfCell

• XCell vertJustify

Constructor Detail

• SpreadsheetExtension()

Method Detail

• static XSpreadsheet getActiveSheet(XSpreadsheetDocument self)

  Returns the active spreadsheet.

  Returns:

  XSpreadsheet interface of the sheet.

• static CellAddress getAddress(XCell self)

  Returns the cell address of the cell.

  Returns:

  CellAddress the cell address within the spreadsheet document.

• static java.util.List<XCell> getCellList(XSheetCellRanges self)

  Returns a list of XCells contained in the range.

  Returns:

  List < XCell > list of XCells contained in the range.

• static java.util.List<XCell> getCellList(XSheetCellRangeContainer self)

  Returns a list of XCells contained in the range container.

  Returns:

  List < XCell > list of XCells contained in the range container.

• static XSheetCellRanges getCellRanges(XSpreadsheet self, java.lang.Object type)

  Returns the cell ranges matching the specified type.

  Parameters:

  type - a combination of CellFlags flags.

  Returns:

  Object all cells of the current cell range(s) with the specified content type(s).

• static java.lang.Object getCellStyle(XCell self)

  Returns the CellStyle property.

  Returns:

  Object value determined by the cell style.

• static com.sun.star.beans.XPropertySet getCellStylePropertySet(XSpreadsheetDocument self, java.lang.String cellStyle)

  Returns the property set of the cell style if it exists. If not the the cell style is created and it's property set is returned.

  Parameters:

  cellStyle - the name of the cell style to return the property set of.

  Returns:

  XPropertySet the property set of the cell style.

• static java.lang.String getFormulaOfCell(XCellRange self, int column, int row)

  Returns the formula string of a cell. Even if the cell does not contain a formula, an assignment of this attribute's value to another cell's formula attribute would create the same cell content. This is because this attribute contains the original text value of a string cell. The value of a value cell will be formatted using the number format's default format or the formula string, including "=", of a formula cell. If called on a Range the column and row is relative to that range.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet

  column - zero based column position.

  row - zero based row position.

  Returns:

  String the formula string of a cell.

• static java.lang.Object getPropertyValue(XCell self, java.lang.String prop)

  Returns the value of the property.

  Parameters:

  prop - The name of the property to get.

  Returns:

  Object value of a type determined by the property.

• static XSheetCellRangeContainer getRangeContainer(XSpreadsheetDocument self)

  Returns a sheet cell range container.

  Returns:

  XSheetCellRangeContainer a sheet cell range container of the sheet.

• static XSpreadsheet getSheetByIndex(XSpreadsheetDocument self, java.lang.Integer nIndex)

  Returns the spreadsheet with the specified index (0-based).

  Parameters:

  nIndex - The index of the sheet.

  Returns:

  XSpreadsheet interface of the sheet.

• static XSpreadsheet getSheetByName(XSpreadsheetDocument self, java.lang.String name)

  Returns the spreadsheet with the specified name.

  Parameters:

  name - The name of the sheet.

  Returns:

  XSpreadsheet interface of the sheet.

• static XSpreadsheetDocument getSpreadsheetDocument(com.sun.star.lang.XComponent self, com.sun.star.uno.XComponentContext mxRemoteContext)

  Returns the spreadsheet document with the specified component context

  Parameters:

  mxRemoteContext - the remote context.

  Returns:

  XSpreadsheetDocument interface of the spreadsheet document.

• static com.sun.star.style.XStyleFamiliesSupplier getStyleFamiliesSupplier(XSpreadsheetDocument self)

  Returns the style families supplier

  Returns:

  XStyleFamiliesSupplier the style families supplier of the spreadsheet document.

• static CellContentType getTypeOfCell(XCellRange self, int column, int row)

  Returns the type of the cell. CellContentType.EMPTY, VALUE, TEXT, or FORMULA.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet.

  column - zero based column position.

  row - zero based row position.

  Returns:

  CellContentType the content type of the cell.

• static java.lang.Double getValueOfCell(XCellRange self, int column, int row)

  Returns the floating point value of the cell specified by column and row. For a value cell the value is returned, for a string cell zero is returned and for a formula cell the result value of a formula is returned.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet

  column - zero based column position.

  row - zero based row position.

  Returns:

  Double value of the cell.

• static java.lang.Integer getVertJustify(XCell self)

  Returns the value of the VertJustify property.

  Returns:

  Integer value of a type determined by the property.

• @java.lang.Deprecated static void insertFormulaIntoCell(XSpreadsheet self, int column, int row, java.lang.String value)

  Inserts a formula (string) value into the cell specified by column and row.

  deprecated:

  As of release 4.1.6.1, replaced by setFormulaOfCell(final XCellRange self, int column, int row, String value)

  Parameters:

  column - zero based column position.

  row - zero based row position.

  value - the string value to insert.

• @java.lang.Deprecated static void insertValueIntoCell(XSpreadsheet self, int column, int row, float value)

  Inserts a float value into the cell specified by column and row.

  deprecated:

  As of release 4.1.6.1, replaced by setValueOfCell(final XCellRange self, int column, int row, float value)

  Parameters:

  column - zero based column position.

  row - zero based row position.

  value - the float value to insert.

• static void setActiveSheet(XSpreadsheetDocument self, XSpreadsheet sht)

  Sets the active spreadsheet

  Parameters:

  sht - The spreadsheet to make active

• static void setCellStyle(XCell self, java.lang.Object value)

  Sets the CellStyle property with the value.

  Parameters:

  value - The value to set.

• static void setColumnWidthOptimalPlus(XCellRange self, int addWidth)

  Sets the width of the columns in XCellRange to optimal plus the additional width.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet.

  column - zero based column position.

  row - zero based row position.

  addWidth - additional width in 1/100th of a millimeter.

• static void setFormulaOfCell(XCellRange self, int column, int row, java.lang.String value)

  Inserts a formula (string) value into the cell specified by column and row. When assigned, the string will be interpreted and a value, text or formula cell is created, depending on the text and the number format.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet

  column - zero based column position.

  row - zero based row position.

  value - the string value to insert.

• static void setPropertyValue(XCell self, java.lang.String prop, java.lang.Object value)

  Sets the specified property with the value.

  Parameters:

  prop - The name of the property to set.

  value - The value to set.

• static void setRowHeightOptimalPlus(XCellRange self, int addHeight)

  Sets the height of the rows in XCellRange to optimal plus the additional height.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet.

  column - zero based column position.

  row - zero based row position.

  addHeight - additional height in 1/100th of a millimeter.

• static void setValueOfCell(XCellRange self, int column, int row, float value)

  Inserts a float value into the cell specified by column and row. After a call to this method the type of the cell is CellContentType.VALUE.

  Parameters:

  self - XCellRange, XSheetCellRange, or XSpreadsheet.

  column - zero based column position.

  row - zero based row position.

  value - the float value to insert.

• static void setVertJustify(XCell self, java.lang.Object value)

  Sets the VertJustify property with the value.

  Parameters:

  value - The value to set.