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

extends XSpreadsheets interface to import external sheets. More...

import"XSpreadsheets2.idl";

Inheritance diagram for XSpreadsheets2:
XSpreadsheets XNameContainer XNameReplace XNameAccess XElementAccess XInterface

Public Member Functions

long importSheet ([in] com::sun::star::sheet::XSpreadsheetDocument srcDoc, [in] string srcName, [in] long nDestPosition) raises (com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException)
 copies a sheet from a source document. More...
 
- Public Member Functions inherited from XSpreadsheets
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

extends XSpreadsheets interface to import external sheets.

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

Member Function Documentation

◆ importSheet()

long importSheet ( [in] com::sun::star::sheet::XSpreadsheetDocument  srcDoc,
[in] string  srcName,
[in] long  nDestPosition 
)
raises (com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::IndexOutOfBoundsException
)

copies a sheet from a source document.

Parameters
srcDoca valid XSpreadsheetDocument reference to source doc
srcNamethe source sheet name. Throw IllegalArgumentException if not valid
nDestPositionthe destination sheet position. Throw IndexOutOfBoundsException if not valid
Returns
the position of the imported sheet
Exceptions
com::sun::star::lang::IllegalArgumentException
com::sun::star::lang::IndexOutOfBoundsException
Since
LibreOffice 3.5

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