Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XScenario
Description
provides access to the settings of a scenario sheet.
See also
Spreadsheet

Methods' Summary
getIsScenario returns true if the current object is a scenario.  
getScenarioComment returns the comment for the scenario.  
setScenarioComment sets a new comment for the scenario.  
addRanges adds more ranges to the scenario.  
apply applies the scenario.  
Methods' Details
getIsScenario
boolean
getIsScenario();

Description
returns true if the current object is a scenario.
getScenarioComment
string
getScenarioComment();

Description
returns the comment for the scenario.
setScenarioComment
void
setScenarioComment( [in] string  aScenarioComment );

Description
sets a new comment for the scenario.
addRanges
void
addRanges( [in] sequence< ::com::sun::star::table::CellRangeAddress >  aRanges );

Description
adds more ranges to the scenario.
apply
void
apply();

Description
applies the scenario.

The contents of the scenario ranges are copied into the first non-scenario sheet which is in front of the sheet containing the scenario by itself.

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.