The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XCellRangesQuery
Description
provides methods to query for cell ranges with specific contents.

All methods return a collection of cell ranges.

See also
SheetRangesQuery, SheetCellRanges
Developers Guide
Spreadsheets - Querying for Cells with Specific Properties

Methods' Summary
queryVisibleCells queries all visible cells.  
queryEmptyCells queries all empty cells.  
queryContentCells queries all cells with the specified content type(s).  
queryFormulaCells queries all formula cells with the specified result type.  
queryColumnDifferences queries all cells with different values in a specified row.  
queryRowDifferences queries all cells with different values in a specified column.  
queryIntersection intersects the current cell range(s) with the specified cell range.  
Methods' Details
queryVisibleCells
XSheetCellRanges
queryVisibleCells();

Description
queries all visible cells.
Returns
the visible (not hidden) cells of the current cell range(s).
queryEmptyCells
XSheetCellRanges
queryEmptyCells();

Description
queries all empty cells.
Returns
the empty cells of the current cell range(s).
queryContentCells
XSheetCellRanges
queryContentCells( [in] short  nContentFlags );

Description
queries all cells with the specified content type(s).
Parameter nContentFlags
a combination of CellFlags flags.

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

Returns
all cells of the current cell range(s) with the specified content type(s).
queryFormulaCells
XSheetCellRanges
queryFormulaCells( [in] long  nResultFlags );

Description
queries all formula cells with the specified result type.
Parameter nResultFlags
a combination of FormulaResult flags.
Returns
all formula cells of the current cell range(s) with the specified result type(s).
queryColumnDifferences
XSheetCellRanges
queryColumnDifferences( [in] ::com::sun::star::table::CellAddress  aCompare );

Description
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.

Parameter 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.
queryRowDifferences
XSheetCellRanges
queryRowDifferences( [in] ::com::sun::star::table::CellAddress  aCompare );

Description
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.

Parameter 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.
queryIntersection
XSheetCellRanges
queryIntersection( [in] ::com::sun::star::table::CellRangeAddress  aRange );

Description
intersects the current cell range(s) with the specified cell range.
Parameter aRange
contains the cell range for intersection.
Returns
all cells of the current cell range(s) which are contained in the passed cell range.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.