LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
DatabaseRange Service Referencepublished

represents a database range in a spreadsheet document. More...

import"DatabaseRange.idl";

Inheritance diagram for DatabaseRange:
XDatabaseRange XCellRangeReferrer XPropertySet XNamed XRefreshable XInterface XInterface XInterface XInterface XInterface

Exported Interfaces

interface com::sun::star::sheet::XDatabaseRange
 
interface com::sun::star::sheet::XCellRangeReferrer
 
interface com::sun::star::beans::XPropertySet
 
interface com::sun::star::container::XNamed
 
interface com::sun::star::util::XRefreshable
 

Public Attributes

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. More...
 
boolean KeepFormats
 if this property is set, cell formats are extended when the size of the range is changed by an update operation. More...
 
boolean StripData
 if this property is set, the cell contents within the database range are left out when the document is saved. More...
 
boolean AutoFilter
 specifies whether the AutoFilter is enabled or not. More...
 
boolean UseFilterCriteriaSource
 specifies whether the filter criteria should be taken from a CellRange. More...
 
com::sun::star::table::CellRangeAddress FilterCriteriaSource
 specifies the range where the filter can find the filter criteria. More...
 
long RefreshPeriod
 specifies the time between two refresh actions in seconds. More...
 
boolean FromSelection
 specifies whether the imported data is only a selection of the database. More...
 
long TokenIndex
 returns the index used to refer to this range in token arrays. More...
 
boolean TotalsRow
 specifies whether this range includes a bottom row of totals. More...
 
boolean ContainsHeader
 specifies whether this range includes a top row of headers. More...
 

Additional Inherited Members

- Public Member Functions inherited from XDatabaseRange
com::sun::star::table::CellRangeAddress getDataArea ()
 returns the data area of the database range in the spreadsheet document. More...
 
void setDataArea ([in] com::sun::star::table::CellRangeAddress aDataArea)
 sets the data area of the database range. More...
 
sequence< com::sun::star::beans::PropertyValuegetSortDescriptor ()
 returns the sort descriptor stored with the database range. More...
 
XSheetFilterDescriptor getFilterDescriptor ()
 returns the filter descriptor stored with the database range. More...
 
XSubTotalDescriptor getSubTotalDescriptor ()
 returns the subtotal descriptor stored with the database range. More...
 
sequence< com::sun::star::beans::PropertyValuegetImportDescriptor ()
 returns the database import descriptor stored with this database range. More...
 
void refresh ()
 executes the stored import, filter, sorting, and subtotals descriptors again. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XCellRangeReferrer
com::sun::star::table::XCellRange getReferredCells ()
 returns the cell range object that is represented. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Protected Member Functions inherited from XRefreshable
void refresh ()
 refreshes the data of the object from the connected data source. More...
 
void addRefreshListener ([in] com::sun::star::util::XRefreshListener l)
 adds the specified listener to receive the event "refreshed." More...
 
void removeRefreshListener ([in] com::sun::star::util::XRefreshListener l)
 removes the specified listener. More...
 

Detailed 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
com::sun::star::sheet::DatabaseRanges
Developers Guide
Spreadsheets - Database Operations

Exported Interfaces

Member Data Documentation

boolean AutoFilter
optionalproperty

specifies whether the AutoFilter is enabled or not.

Since
OOo 1.1.2
boolean ContainsHeader
optionalproperty

specifies whether this range includes a top row of headers.

Since
LibreOffice 5.0
com::sun::star::table::CellRangeAddress FilterCriteriaSource
optionalproperty

specifies the range where the filter can find the filter criteria.

This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is TRUE.

Since
OOo 1.1.2
boolean FromSelection
optionalproperty

specifies whether the imported data is only a selection of the database.

Since
OOo 2.0
boolean KeepFormats
property

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

boolean MoveCells
property

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

long RefreshPeriod
optionalproperty

specifies the time between two refresh actions in seconds.

Since
OOo 2.0
boolean StripData
property

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

long TokenIndex
optionalpropertyreadonly

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.

See also
com::sun::star::sheet::FormulaToken
com::sun::star::sheet::FormulaMapGroupSpecialOffset::DB_AREA
Since
OOo 3.0
boolean TotalsRow
optionalproperty

specifies whether this range includes a bottom row of totals.

Since
LibreOffice 5.0
boolean UseFilterCriteriaSource
optionalproperty

specifies whether the filter criteria should be taken from a CellRange.

Since
OOo 1.1.2

The documentation for this service was generated from the following file: