Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XNamedRanges
Base Interfaces
XNamedRanges
┗ ::com::sun::star::container::XNameAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::container::XNameAccess
(referenced interface's summary:)
is used to access named objects within a container.
Description
provides access to the members in a collection of named ranges and to insert and remove them.
See also
NamedRanges, NamedRange
Developers Guide
Spreadsheets - Named Ranges

Methods' Summary
addNewByName adds a new named range to the collection.  
addNewFromTitles creates named cell ranges from titles in a cell range.  
removeByName removes a named range from the collection.  
outputList writes a list of all named ranges into the document.  
Methods' Details
addNewByName
void
addNewByName( [in] string  aName,
[in] string  aContent,
[in] ::com::sun::star::table::CellAddress  aPosition,
[in] long  nType );

Description
adds a new named range to the collection.
Parameter aName
the new name of the named range.
Parameter aContent
the formula expression.

A cell range address is one possible content of a named range.

Parameter aPosition
specifies the base address for relative cell references.
Parameter nType
a combination of flags that specify the type of a named range, as defined in NamedRangeFlag.

This parameter will be zero for any common named range.

addNewFromTitles
void
addNewFromTitles( [in] ::com::sun::star::table::CellRangeAddress  aSource,
[in] Border  aBorder );

Description
creates named cell ranges from titles in a cell range.

The names for the named ranges are taken from title cells in the top or bottom row, or from the cells of the left or right column of the range (depending on the parameter aBorder. The named ranges refer to single columns or rows in the inner part of the original range, excluding the labels.

Example: The source range is A1:B3. The named ranges shall be created using row titles. This requires Border::TOP for the second parameter. The method creates two named ranges. The name of the first is equal to the content of cell A1 and contains the range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named range is named using cell B1 and contains the cell range address $Sheet.$B$2:$B$3.

Parameter aSource
the cell range used to create the named ranges.
Parameter aBorder
specifies the location of the title cells.
removeByName
void
removeByName( [in] string  aName );

Description
removes a named range from the collection.
outputList
void
outputList( [in] ::com::sun::star::table::CellAddress  aOutputPosition );

Description
writes a list of all named ranges into the document.

The first column of the list contains the names. The second column contains the contents of the named ranges.

Parameter aOutputPosition
specifies the top left cell of the output range.
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.