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

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

interface XSheetCellRangeContainer

Base Interface
com::sun::star::sheet::XSheetCellRanges

Description
provides methods to access cell ranges in a collection via index and to add and remove cell ranges.
See also
com::sun::star::sheet::SheetCellRanges


Known Services which Export this Interface

com::sun::star::sheet::SheetCellRanges represents a collection of cell ranges in a spreadsheet document.

Methods' Summary

addRangeAddress adds the given range to the collection of cell ranges.
removeRangeAddress removes the given range from the collection of cell ranges.
addRangeAddresses adds the given ranges to the collection of cell ranges.
removeRangeAddresses removes the given ranges from the collection of cell ranges.

Methods' Details

addRangeAddress
 
void
addRangeAddress(
[ in ] com::sun::star::table::CellRangeAddress aCellRangeAddress,
[ in ] boolean bMergeRanges );

Description
adds the given range to the collection of cell ranges.
Parameter aCellRangeAddress
contains the address of the new range.
Parameter bMergeRanges
defines how the range should be added. To merge the ranges takes more time, but the memory usage is lower.
removeRangeAddress
 
void
removeRangeAddress(
[ in ] com::sun::star::table::CellRangeAddress aCellRangeAddress )
raises ( com::sun::star::container::NoSuchElementException );

Description
removes the given range from the collection of cell ranges.
Parameter aCellRangeAddress
contains the address of the range to be removed.

The specified range must fit exactly to an element of the collection. The method does not try to shorten a range.

Throws
com::sun::star::container::NoSuchElementException if the collection does not contain the specified range.
addRangeAddresses
 
void
addRangeAddresses(
[ in ] sequence< com::sun::star::table::CellRangeAddress > aCellRangeAddresses,
[ in ] boolean bMergeRanges );

Description
adds the given ranges to the collection of cell ranges.
Parameter aCellRangeAddresses
contains a sequence of addresses of all new ranges.
Parameter bMergeRanges
defines how the ranges should be added. To merge the ranges takes more time, but the memory usage is lower.
removeRangeAddresses
 
void
removeRangeAddresses(
[ in ] sequence< com::sun::star::table::CellRangeAddress > aCellRangeAddresses )
raises ( com::sun::star::container::NoSuchElementException );

Description
removes the given ranges from the collection of cell ranges.
Parameter aCellRangeAddresses
contains a sequence of addresses of all ranges to be removed.

All specified ranges must fit exactly to elements of the collection. The method does not try to shorten ranges.

Throws
com::sun::star::container::NoSuchElementException if the collection does not contain any of the specified ranges.

Top of Page