Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » sheet

Overview

Module

Use

Devguide

Index

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

---

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

service DatabaseRange

Description represents a database range in a spreadsheet document. A database range is a name for a cell range that also stores filtering, sorting, subtotal and data import settings and options. See also DatabaseRanges Developers Guide Spreadsheets - Database Operations

---

Exported Interfaces - Summary
XDatabaseRange	(referenced entity's summary:) provides access to the settings and options of a database range.
XCellRangeReferrer	(referenced entity's summary:) allows direct access to the cells in a named range or to the cells which are visible in a view, without the need to get the document object first.
::com::sun::star::beans::XPropertySet	(referenced entity's summary:) provides information about and access to the properties from an implementation.
::com::sun::star::container::XNamed	(referenced entity's summary:) specifies the name of the object.
::com::sun::star::util::XRefreshable

Properties' Summary
boolean MoveCells	if this property is set, columns or rows are inserted or deleted when the size of the range is changed by an update operation.
boolean KeepFormats	if this property is set, cell formats are extended when the size of the range is changed by an update operation.
boolean StripData	if this property is set, the cell contents within the database range are left out when the document is saved.
boolean AutoFilter	[ OPTIONAL ] specifies whether the AutoFilter is enabled or not.
boolean UseFilterCriteriaSource	[ OPTIONAL ] specifies whether the filter criteria should be taken from a CellRange.
::com::sun::star::table::CellRangeAddress FilterCriteriaSource	[ OPTIONAL ] specifies the range where the filter can find the filter criterias.
long RefreshPeriod	[ OPTIONAL ] specifies the time between two refresh actions in seconds.
boolean FromSelection	[ OPTIONAL ] specifies whether the imported data is only a selection of the database.
[ readonly ] long TokenIndex	[ OPTIONAL ] returns the index used to refer to this range in token arrays.

Exported Interfaces - Details

XDatabaseRange (referenced entity's summary:) provides access to the settings and options of a database range.

XCellRangeReferrer (referenced entity's summary:) allows direct access to the cells in a named range or to the cells which are visible in a view, without the need to get the document object first.

::com::sun::star::beans::XPropertySet (referenced entity's summary:) provides information about and access to the properties from an implementation.

::com::sun::star::container::XNamed (referenced entity's summary:) specifies the name of the object.

::com::sun::star::util::XRefreshable Usage Restrictions optional

Properties' Details

MoveCells boolean MoveCells; Description if this property is set, columns or rows are inserted or deleted when the size of the range is changed by an update operation.

KeepFormats boolean KeepFormats; Description if this property is set, cell formats are extended when the size of the range is changed by an update operation.

StripData boolean StripData; Description if this property is set, the cell contents within the database range are left out when the document is saved.

AutoFilter boolean AutoFilter; Usage Restrictions optional Description specifies whether the AutoFilter is enabled or not. Since OOo 1.1.2

UseFilterCriteriaSource boolean UseFilterCriteriaSource; Usage Restrictions optional Description specifies whether the filter criteria should be taken from a CellRange. Since OOo 1.1.2

FilterCriteriaSource ::com::sun::star::table::CellRangeAddress FilterCriteriaSource; Usage Restrictions optional Description specifies the range where the filter can find the filter criterias. This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is true. Since OOo 1.1.2

RefreshPeriod long RefreshPeriod; Usage Restrictions optional Description specifies the time between two refresh actions in seconds. Since OOo 2.0

FromSelection boolean FromSelection; Usage Restrictions optional Description specifies whether the imported data is only a selection of the database. Since OOo 2.0

TokenIndex [ readonly ] long TokenIndex; Usage Restrictions optional Description returns the index used to refer to this range in token arrays. A token describing a database range shall contain the op-code obtained from the FormulaMapGroupSpecialOffset::DB_AREA and this index as data part. Since OOo 3.0 See also FormulaToken, FormulaMapGroupSpecialOffset::DB_AREA

 Top of Page

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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.