LibreOffice: NamedRange Service Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Exported Interfaces | Public Attributes | List of all members
NamedRange Service Referencepublished

represents a named range in a spreadsheet document. More...

Inheritance diagram for NamedRange:

## Exported Interfaces
interface | com::sun::star::sheet::XNamedRange
| provides access to the settings of the named range.
interface | com::sun::star::sheet::XCellRangeReferrer
| provides access to the cell range object referred by this named range.

## Public Attributes
long | TokenIndex
| returns the index used to refer to this name in token arrays.
boolean | IsSharedFormula
| Determines if this defined name represents a shared formula.

## Additional Inherited Members
Public Member Functions inherited from XNamedRange
string | getContent ()
| returns the content of the named range.
void | setContent ([in] string aContent)
| sets the content of the named range.
com::sun::star::table::CellAddress | getReferencePosition ()
| returns the position in the document which is used as a base for relative references in the content.
void | setReferencePosition ([in] com::sun::star::table::CellAddress aReferencePosition)
| sets the position in the document which is used as a base for relative references in the content.
long | getType ()
| returns the type of the named range.
void | setType ([in] long nType)
| sets the type of the named range.
Public Member Functions inherited from XNamed
string | getName ()
void | setName ([in] string aName)
| sets the programmatic name of the object.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.
Public Member Functions inherited from XCellRangeReferrer
com::sun::star::table::XCellRange | getReferredCells ()
| returns the cell range object that is represented.

## Detailed Description

represents a named range in a spreadsheet document.

In fact a named range is a named formula expression. A cell range address is one possible content of a named range.

See also
  com::sun::star::sheet::NamedRanges

## Exported Interfaces

## ◆ com::sun::star::sheet::XCellRangeReferrer

interface com::sun::star::sheet::XCellRangeReferrer

provides access to the cell range object referred by this named range.

This works only, if the named range contains a single cell range address.

## ◆ com::sun::star::sheet::XNamedRange

interface com::sun::star::sheet::XNamedRange

provides access to the settings of the named range.

## Member Data Documentation

## ◆ IsSharedFormula

boolean IsSharedFormula
| optionalproperty

Determines if this defined name represents a shared formula.

This special property shall not be used externally. It is used by import and export filters for compatibility with spreadsheet documents containing shared formulas. Shared formulas are shared by several cells to save memory and to decrease file size.

A defined name with this property set will not appear in the user interface of Calc, and its name will not appear in cell formulas. A formula referring to this defined name will show the formula definition contained in the name instead.

Since
  OOo 3.0

## ◆ TokenIndex

long TokenIndex
| optionalpropertyreadonly

returns the index used to refer to this name in token arrays.

A token describing a defined name shall contain the op-code obtained from the FormulaMapGroupSpecialOffset::NAME offset and this index as data part.

See also
  com::sun::star::sheet::FormulaToken
  com::sun::star::sheet::FormulaMapGroupSpecialOffset::NAME

Since
  OOo 3.0

The documentation for this service was generated from the following file:

- com/sun/star/sheet/NamedRange.idl