Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XSheetCellRangeContainer
Base Interfaces
XSheetCellRangeContainer
┗ XSheetCellRanges
   ┗ ::com::sun::star::container::XIndexAccess
      ┗ ::com::sun::star::container::XElementAccess
XSheetCellRanges
(referenced interface's summary:)
provides methods to access cell ranges in a collection via index and other helper methods.
Description
provides methods to access cell ranges in a collection via index and to add and remove cell ranges.
See also
SheetCellRanges
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

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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