Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XScenarios
Base Interfaces
XScenarios
┗ ::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 via name to the scenarios in a collection and inserting and removing scenarios.
See also
Scenarios, Spreadsheet
Developers Guide
Spreadsheets - Other Table Operations - Scenarios

Methods' Summary
addNewByName creates a new scenario and adds it to the collection.  
removeByName removes a scenario from the collection.  
Methods' Details
addNewByName
void
addNewByName( [in] string  aName,
[in] sequence< ::com::sun::star::table::CellRangeAddress >  aRanges,
[in] string  aComment );

Description
creates a new scenario and adds it to the collection.
Parameter aName
the name of the scenario (used i.e. for collection access).
Parameter aRanges
the cell ranges contained in the scenario.
Parameter aComment
the user defined comment for the scenario.
removeByName
void
removeByName( [in] string  aName );

Description
removes a scenario from the collection.
Top of Page

Apache Software Foundation

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

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.