LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XSpreadsheets Interface Referencepublished

provides methods to access the spreadsheets by name and to insert, copy, remove and rearrange spreadsheets. More...

import"XSpreadsheets.idl";

Inheritance diagram for XSpreadsheets:
XNameContainer XNameReplace XNameAccess XElementAccess XInterface Spreadsheets XSpreadsheets2

Public Member Functions

void insertNewByName ([in] string aName, [in] short nPosition)
 inserts a new sheet into the collection. More...
 
void moveByName ([in] string aName, [in] short nDestination)
 moves a sheet within the collection. More...
 
void copyByName ([in] string aName, [in] string aCopy, [in] short nDestination)
 copies a sheet within the collection. More...
 
- Public Member Functions inherited from XNameContainer
void insertByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 inserts the given element at the specified name. More...
 
void removeByName ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 removes the element with the specified name. More...
 
- Public Member Functions inherited from XNameReplace
void replaceByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 replaces the element with the specified name with the given element. More...
 
- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides methods to access the spreadsheets by name and to insert, copy, remove and rearrange spreadsheets.

See also
com::sun::star::sheet::Spreadsheets

Member Function Documentation

◆ copyByName()

void copyByName ( [in] string  aName,
[in] string  aCopy,
[in] short  nDestination 
)

copies a sheet within the collection.

Parameters
aNamethe name of the spreadsheet to copy.
aCopythe name of the copy of the spreadsheet.
nDestinationthe index of the copy in the collection.

◆ insertNewByName()

void insertNewByName ( [in] string  aName,
[in] short  nPosition 
)

inserts a new sheet into the collection.

Parameters
aNamethe name of the new spreadsheet.
nPositionthe index of the new spreadsheet in the collection.

◆ moveByName()

void moveByName ( [in] string  aName,
[in] short  nDestination 
)

moves a sheet within the collection.

Parameters
aNamethe name of the spreadsheet to move.
nDestinationthe new index of the spreadsheet in the collection.

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