LibreOffice
LibreOffice 7.4 SDK API Reference
Public Member Functions | List of all members
XScenarios Interface Referencepublished

provides access via name to the scenarios in a collection and inserting and removing scenarios. More...

import"XScenarios.idl";

Inheritance diagram for XScenarios:
XNameAccess XElementAccess XInterface Scenarios

Public Member Functions

void addNewByName ([in] string aName, [in] sequence< com::sun::star::table::CellRangeAddress > aRanges, [in] string aComment)
 creates a new scenario and adds it to the collection. More...
 
void removeByName ([in] string aName)
 removes a scenario from the collection. 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 access via name to the scenarios in a collection and inserting and removing scenarios.

See also
com::sun::star::sheet::Scenarios
com::sun::star::sheet::Spreadsheet
Developers Guide
Spreadsheet Documents - Other Table Operations - Scenarios

Member Function Documentation

◆ addNewByName()

void addNewByName ( [in] string  aName,
[in] sequence< com::sun::star::table::CellRangeAddress aRanges,
[in] string  aComment 
)

creates a new scenario and adds it to the collection.

Parameters
aNamethe name of the scenario (used i.e. for collection access).
aRangesthe cell ranges contained in the scenario.
aCommentthe user defined comment for the scenario.

◆ removeByName()

void removeByName ( [in] string  aName)

removes a scenario from the collection.


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