XCellRangesQuery Interface Reference

provides methods to query for cell ranges with specific contents. More...

import"XCellRangesQuery.idl";

Inheritance diagram for XCellRangesQuery:

Public Member Functions
com::sun::star::sheet::XSheetCellRanges	queryVisibleCells ()
	queries all visible cells. More...
com::sun::star::sheet::XSheetCellRanges	queryEmptyCells ()
	queries all empty cells. More...
com::sun::star::sheet::XSheetCellRanges	queryContentCells ([in] short nContentFlags)
	queries all cells with the specified content type(s). More...
com::sun::star::sheet::XSheetCellRanges	queryFormulaCells ([in] long nResultFlags)
	queries all formula cells with the specified result type. More...
com::sun::star::sheet::XSheetCellRanges	queryColumnDifferences ([in] com::sun::star::table::CellAddress aCompare)
	queries all cells with different values in a specified row. More...
com::sun::star::sheet::XSheetCellRanges	queryRowDifferences ([in] com::sun::star::table::CellAddress aCompare)
	queries all cells with different values in a specified column. More...
com::sun::star::sheet::XSheetCellRanges	queryIntersection ([in] com::sun::star::table::CellRangeAddress aRange)
	intersects the current cell range(s) with the specified cell range. 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...

Detailed Description

provides methods to query for cell ranges with specific contents.

All methods return a collection of cell ranges.

See also

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

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

Developers Guide

Spreadsheet Documents - Querying for Cells with Specific Properties

Member Function Documentation

queryColumnDifferences()

com::sun::star::sheet::XSheetCellRanges queryColumnDifferences

(

[in] com::sun::star::table::CellAddress

aCompare

)

queries all cells with different values in a specified row.

This method takes each column of the current cell range(s) and compares all cells with the cell in the specified row. All cells which are different to this comparison cell will be returned.

Parameters

aCompare

contains a cell address with the row index used for comparison. Only this row index is of interest.

Returns

all cells of the current cell range(s) which are different to the comparison cell of each column.

queryContentCells()

com::sun::star::sheet::XSheetCellRanges queryContentCells

(

[in] short

nContentFlags

)

queries all cells with the specified content type(s).

Parameters

nContentFlags

a combination of CellFlags flags.

Attention: Despite the CellFlags flags are long values, this method expects a short parameter.

Attention: Empty cells in the range may be skipped depending on the content flag used. For instance, when querying for STYLES, the returned ranges may not include empty cells even if styles are applied to those cells.

Returns

all cells of the current cell range(s) with the specified content type(s).

queryEmptyCells()

com::sun::star::sheet::XSheetCellRanges queryEmptyCells

(

)

queries all empty cells.

Returns

the empty cells of the current cell range(s).

queryFormulaCells()

com::sun::star::sheet::XSheetCellRanges queryFormulaCells

(

[in] long

nResultFlags

)

queries all formula cells with the specified result type.

Parameters

nResultFlags

a combination of FormulaResult flags.

Returns

all formula cells of the current cell range(s) with the specified result type(s).

queryIntersection()

com::sun::star::sheet::XSheetCellRanges queryIntersection

(

[in] com::sun::star::table::CellRangeAddress

aRange

)

intersects the current cell range(s) with the specified cell range.

Parameters

aRange

contains the cell range for intersection.

Returns

all cells of the current cell range(s) which are contained in the passed cell range.

queryRowDifferences()

com::sun::star::sheet::XSheetCellRanges queryRowDifferences

(

[in] com::sun::star::table::CellAddress

aCompare

)

queries all cells with different values in a specified column.

This method takes each row of the current cell range(s) and compares all cells with the cell in the specified column. All cells which are different to this comparison cell will be returned.

Parameters

aCompare

contains a cell address with the column index used for comparison. Only this column index is of interest.

Returns

all cells of the current cell range(s) which are different to the comparison cell of each row.

queryVisibleCells()

com::sun::star::sheet::XSheetCellRanges queryVisibleCells

(

)

queries all visible cells.

Returns

the visible (not hidden) cells of the current cell range(s).

---

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

• com/sun/star/sheet/XCellRangesQuery.idl