ooodev.adapter.sheet.database_range_partial module

class ooodev.adapter.sheet.database_range_partial.DatabaseRangePartial(component, interface=com.sun.star.sheet.XDatabaseRange)

Bases: object

Partial Class for XDatabaseRange.

Parameters:

• component (XDatabaseRange) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.sheet.XDatabaseRange)

Constructor

Parameters:

• component (XDatabaseRange) – UNO Component that implements com.sun.star.sheet.XDatabaseRange.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XDatabaseRange.

Return type:

None

get_data_area()

Returns the data area of the database range in the spreadsheet document.

Return type:

CellRangeAddress

get_filter_descriptor()

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.

Return type:

XSheetFilterDescriptor

get_import_descriptor()

Returns the database import descriptor stored with this database range.

Return type:

Tuple[PropertyValue, ...]

get_sort_descriptor()

Returns the sort descriptor stored with the database range.

Return type:

Tuple[PropertyValue, ...]

get_sub_total_descriptor()

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.

Return type:

XSubTotalDescriptor

refresh()

Executes the stored import, filter, sorting, and subtotals descriptors again.

Return type:

None

set_data_area(data_area)

Sets the data area of the database range.

Return type:

None

Parameters:

data_area (CellRangeAddress) –