Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sheet ::

service SheetCellRange
Description
represents a rectangular range of cells in a spreadsheet document.

This service is an extension of the CellRange service for use in spreadsheet documents.

Developers Guide
Spreadsheets - Spreadsheet Services - Overview
Spreadsheets - Cell Ranges
Spreadsheets - Cell and Cell Range Access

Included Services - Summary
::com::sun::star::table::CellRange

provides basic handling of cell ranges and contributes common cell formatting properties.

::com::sun::star::style::CharacterProperties

contributes properties for character formatting of Western text.

::com::sun::star::style::CharacterPropertiesAsian

contributes properties for character formatting of Asian text.

::com::sun::star::style::CharacterPropertiesComplex

contributes properties for character formatting of Complex text.

::com::sun::star::style::ParagraphProperties

contributes properties for paragraph formatting.

SheetRangesQuery

provides interfaces to find cells with specific properties.

Exported Interfaces - Summary
::com::sun::star::util::XReplaceable

provides "Find & Replace" functionality. (details)

::com::sun::star::util::XMergeable

provides merging and unmerging the cells of this cell range.

::com::sun::star::util::XIndent

provides modifying the cell indentation.

::com::sun::star::table::XColumnRowRange

provides access to the collections of columns and rows.

::com::sun::star::table::XAutoFormattable

provides applying an AutoFormat to the cell range.

XSheetCellRange

provides access to the spreadsheet that contains this cell range.

XCellRangeData

provides simultaneous access to the contents of all cells.

XCellRangeFormula

provides simultaneous access to the formula contents of all cells. (details)

XCellRangeAddressable

provides access to the cell range address of this range.

XSheetOperation

provides computation of a value based on the contents of all cells of this range and to clear specific cells.

XCellSeries

provides filling out the cell range automatically with values based on a start value, step count and fill mode.

XArrayFormulaRange

provides handling of array formulas.

XMultipleOperation

provides access to the Multiple Operations feature.

::com::sun::star::util::XSortable

provides sorting functionality.

::com::sun::star::util::XImportable

provides functionality to import data from external data sources. (details)

XSubTotalCalculatable

provides calculating SubTotal values in this range.

XSheetFilterableEx

provides filtering the contents of this range.

XCellFormatRangesSupplier

provide access to a collection of equal-formatted cell ranges.

XUniqueCellFormatRangesSupplier

provide access to a collection of equal-formatted cell ranges.

::com::sun::star::chart::XChartDataArray

provides modifying the source data cells of a chart and makes it possible to learn about changes in the cell values.

::com::sun::star::beans::XTolerantMultiPropertySet
::com::sun::star::util::XModifyBroadcaster
Properties' Summary
[ readonly ] ::com::sun::star::awt::Point
Position
contains the position of the top left cell of this range in the sheet (in 1/100 mm).  
[ readonly ] ::com::sun::star::awt::Size
Size
contains the size of this range (in 1/100 mm).  
XSheetConditionalEntries
ConditionalFormat
contains the conditional formatting settings for this cell.  
XSheetConditionalEntries
ConditionalFormatLocal
[ OPTIONAL ]
contains the conditional formatting settings for this cell, using localized formulas.  
::com::sun::star::beans::XPropertySet
Validation
contains the data validation settings for this cell.  
::com::sun::star::beans::XPropertySet
ValidationLocal
[ OPTIONAL ]
contains the data validation settings for this cell, using localized formulas.  
[ readonly ] string
AbsoluteName
[ OPTIONAL ]
Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2:$D$5".  
Included Services - Details
::com::sun::star::table::CellRange
Description
provides basic handling of cell ranges and contributes common cell formatting properties.
::com::sun::star::style::CharacterProperties
Description
contributes properties for character formatting of Western text.
::com::sun::star::style::CharacterPropertiesAsian
Description
contributes properties for character formatting of Asian text.
::com::sun::star::style::CharacterPropertiesComplex
Description
contributes properties for character formatting of Complex text.
::com::sun::star::style::ParagraphProperties
Description
contributes properties for paragraph formatting.
SheetRangesQuery
Description
provides interfaces to find cells with specific properties.
Exported Interfaces - Details
::com::sun::star::util::XReplaceable
Description
provides "Find & Replace" functionality.

The property ::com::sun::star::util::SearchDescriptor::SearchWords has a different meaning in spreadsheets: If set to true, the spreadsheet searches for cells containing the serch text only.

::com::sun::star::util::XMergeable
Description
provides merging and unmerging the cells of this cell range.
::com::sun::star::util::XIndent
Description
provides modifying the cell indentation.
::com::sun::star::table::XColumnRowRange
Description
provides access to the collections of columns and rows.
::com::sun::star::table::XAutoFormattable
Description
provides applying an AutoFormat to the cell range.
XSheetCellRange
Description
provides access to the spreadsheet that contains this cell range.
XCellRangeData
Description
provides simultaneous access to the contents of all cells.
XCellRangeFormula
Usage Restrictions
optional
Description
provides simultaneous access to the formula contents of all cells.
Since
OOo 1.1.2
XCellRangeAddressable
Description
provides access to the cell range address of this range.
XSheetOperation
Description
provides computation of a value based on the contents of all cells of this range and to clear specific cells.
XCellSeries
Description
provides filling out the cell range automatically with values based on a start value, step count and fill mode.
XArrayFormulaRange
Description
provides handling of array formulas.
XMultipleOperation
Description
provides access to the Multiple Operations feature.
::com::sun::star::util::XSortable
Description
provides sorting functionality.
::com::sun::star::util::XImportable
Description
provides functionality to import data from external data sources.
See also
DatabaseImportDescriptor
XSubTotalCalculatable
Description
provides calculating SubTotal values in this range.
XSheetFilterableEx
Description
provides filtering the contents of this range.
XCellFormatRangesSupplier
Description
provide access to a collection of equal-formatted cell ranges.
XUniqueCellFormatRangesSupplier
Description
provide access to a collection of equal-formatted cell ranges.
::com::sun::star::chart::XChartDataArray
Description
provides modifying the source data cells of a chart and makes it possible to learn about changes in the cell values.
::com::sun::star::beans::XTolerantMultiPropertySet
Usage Restrictions
optional
::com::sun::star::util::XModifyBroadcaster
Usage Restrictions
optional
Since
OOo 2.0
Properties' Details
Position
[ readonly ] ::com::sun::star::awt::Point Position;
Description
contains the position of the top left cell of this range in the sheet (in 1/100 mm).

This property contains the absolute position in the whole sheet, not the position in the visible area.

Size
[ readonly ] ::com::sun::star::awt::Size Size;
Description
contains the size of this range (in 1/100 mm).
ConditionalFormat
XSheetConditionalEntries ConditionalFormat;
Description
contains the conditional formatting settings for this cell.

After a conditional format has been changed it has to be reinserted into the property set.

See also
TableConditionalFormat
ConditionalFormatLocal
XSheetConditionalEntries ConditionalFormatLocal;
Usage Restrictions
optional
Description
contains the conditional formatting settings for this cell, using localized formulas.

After a conditional format has been changed it has to be reinserted into the property set.

See also
TableConditionalFormat
Validation
::com::sun::star::beans::XPropertySet Validation;
Description
contains the data validation settings for this cell.

After the data validation settings have been changed the validation has to be reinserted into the property set.

See also
TableValidation
ValidationLocal
::com::sun::star::beans::XPropertySet ValidationLocal;
Usage Restrictions
optional
Description
contains the data validation settings for this cell, using localized formulas.

After the data validation settings have been changed the validation has to be reinserted into the property set.

See also
TableValidation
AbsoluteName
[ readonly ] string AbsoluteName;
Usage Restrictions
optional
Description
Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2:$D$5".

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.