Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

service SheetCell
Description
represents a single addressable cell in a spreadsheet document.
Developers Guide
Spreadsheets - Spreadsheet Services - Overview
Spreadsheets - Cells

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

provides basic cell handling and contributes common cell formatting properties.

::com::sun::star::text::Text

provides handling of formatted text cells.

::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.

::com::sun::star::style::ParagraphPropertiesAsian

contributes properties for paragraph formatting of Asian text. (details)

::com::sun::star::style::ParagraphPropertiesComplex

contributes properties for paragraph formatting of Complex text. (details)

SheetRangesQuery

provides interfaces to find cells with specific properties.

Exported Interfaces - Summary
::com::sun::star::document::XActionLockable

provides methods to lock and unlock the update between ::com::sun::star::table::XCell and ::com::sun::star::text::XText.

::com::sun::star::util::XReplaceable

provides "Find & Replace" functionality. (details)

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

provides modifying the cell indentation.

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

provides access to the collections of columns and rows.

XCellAddressable

provides access to the cell address of this cell.

XSheetAnnotationAnchor

provides access to the annotation attached to this cell.

::com::sun::star::text::XTextFieldsSupplier

provides access to the text fields used in this cell.

::com::sun::star::beans::XTolerantMultiPropertySet
::com::sun::star::util::XModifyBroadcaster
Properties' Summary
[ readonly ] ::com::sun::star::awt::Point
Position
contains the position of this cell in the sheet (in 1/100 mm).  
[ readonly ] ::com::sun::star::awt::Size
Size
contains the size of this cell (in 1/100 mm).  
string
FormulaLocal
[ OPTIONAL ]
contains the formula string with localized function names.  
[ readonly ] long
FormulaResultType
contains the result type of a formula.  
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".  
Included Services - Details
::com::sun::star::table::Cell
Description
provides basic cell handling and contributes common cell formatting properties.
::com::sun::star::text::Text
Description
provides handling of formatted text cells.
::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.
::com::sun::star::style::ParagraphPropertiesAsian
Usage Restrictions
optional
Description
contributes properties for paragraph formatting of Asian text.
::com::sun::star::style::ParagraphPropertiesComplex
Usage Restrictions
optional
Description
contributes properties for paragraph formatting of Complex text.
SheetRangesQuery
Description
provides interfaces to find cells with specific properties.
Exported Interfaces - Details
::com::sun::star::document::XActionLockable
Description
provides methods to lock and unlock the update between ::com::sun::star::table::XCell and ::com::sun::star::text::XText.
::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::XIndent
Description
provides modifying the cell indentation.
::com::sun::star::table::XColumnRowRange
Description
provides access to the collections of columns and rows.
XCellAddressable
Description
provides access to the cell address of this cell.
XSheetAnnotationAnchor
Description
provides access to the annotation attached to this cell.
::com::sun::star::text::XTextFieldsSupplier
Description
provides access to the text fields used in this cell.
::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 this cell 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 cell (in 1/100 mm).
FormulaLocal
string FormulaLocal;
Usage Restrictions
optional
Description
contains the formula string with localized function names.

This property can also be used to set a new localized formula.

FormulaResultType
[ readonly ] long FormulaResultType;
Description
contains the result type of a formula.
See also
FormulaResult
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".

 
Top of Page

Apache Software Foundation

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

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