(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

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

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.