Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XDatabaseRange

Base Interface
com::sun::star::uno::XInterface

Description
represents a cell range for which data operations are defined.
See also
com::sun::star::sheet::DatabaseRange


Known Services which Export this Interface

com::sun::star::sheet::DatabaseRange A database range is a name for a cell range that also stores filtering, sorting, subtotal and import settings and options.

Methods' Summary

getDataArea returns the data area of the database range.
setDataArea sets the data area of the database range.
getSortDescriptor returns the sort descriptor stored with the database range.
getFilterDescriptor returns the filter descriptor stored with the database range.
getSubTotalDescriptor returns the subtotal descriptor stored with the database range.
getImportDescriptor returns the DatabaseImportDescriptor stored with this database range.
refresh executes the stored import, filter, sorting, and subtotals descriptors again.

Methods' Details

getDataArea
 
com::sun::star::table::CellRangeAddress
getDataArea();
Description
returns the data area of the database range.
setDataArea
 
void
setDataArea(
[ in ] com::sun::star::table::CellRangeAddress aDataArea );

Description
sets the data area of the database range.
getSortDescriptor
 
sequence< com::sun::star::beans::PropertyValue >
getSortDescriptor();
Description
returns the sort descriptor stored with the database range.
getFilterDescriptor
 
com::sun::star::sheet::XSheetFilterDescriptor
getFilterDescriptor();
Description
returns the filter descriptor stored with the database range.

If the filter descriptor is modified, the new filtering is carried out when XDatabaseRange::refresh() is called.

getSubTotalDescriptor
 
com::sun::star::sheet::XSubTotalDescriptor
getSubTotalDescriptor();
Description
returns the subtotal descriptor stored with the database range.

If the subtotal descriptor is modified, the new subtotals are inserted when XDatabaseRange::refresh() is called.

getImportDescriptor
 
sequence< com::sun::star::beans::PropertyValue >
getImportDescriptor();
Description
returns the DatabaseImportDescriptor stored with this database range.
refresh
 
void
refresh();
Description
executes the stored import, filter, sorting, and subtotals descriptors again.

Top of Page