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 © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.