<html> <head> <title>Interface XScenario</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XScenario-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title">interface XScenario</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the settings of a scenario sheet. </dd> <dt><b>See also</b></dt> <dd><a href="Spreadsheet.html">Spreadsheet</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getIsScenario">getIsScenario</a></td> <td class="imsum_right">returns <b>true</b> if the current object is a scenario. </td> </tr> <tr> <td class="imsum_left"><a href="#getScenarioComment">getScenarioComment</a></td> <td class="imsum_right">returns the comment for the scenario. </td> </tr> <tr> <td class="imsum_left"><a href="#setScenarioComment">setScenarioComment</a></td> <td class="imsum_right">sets a new comment for the scenario. </td> </tr> <tr> <td class="imsum_left"><a href="#addRanges">addRanges</a></td> <td class="imsum_right">adds more ranges to the scenario. </td> </tr> <tr> <td class="imsum_left"><a href="#apply">apply</a></td> <td class="imsum_right">applies the scenario. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getIsScenario" class="membertitle">getIsScenario</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getIsScenario</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns <b>true</b> if the current object is a scenario. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getScenarioComment" class="membertitle">getScenarioComment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getScenarioComment</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the comment for the scenario. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setScenarioComment" class="membertitle">setScenarioComment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setScenarioComment</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aScenarioComment );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a new comment for the scenario. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addRanges" class="membertitle">addRanges</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addRanges</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a> ></td> <td valign="bottom"> aRanges );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds more ranges to the scenario. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="apply" class="membertitle">apply</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>apply</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>applies the scenario. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
