<html> <head> <title>Interface XPropertyState</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="XPropertyState-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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">beans</a> :: </p> </td> </tr> <tr> <td class="title">interface XPropertyState</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>makes it possible to query information about the state of one or more properties. </dd> <dd><p>The state contains the information if:</p> <ul> <li>a value is available or void</li> <li>the value is stored in the object itself, or if a default value is to be used</li> <li>and if the value cannot be determined, due to ambiguity (multi selection with multiple values).</li> </ul> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Properties">ProUNO - Properties</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Forms/Control_Models">Forms - Control Models</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="#getPropertyState">getPropertyState</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getPropertyStates">getPropertyStates</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setPropertyToDefault">setPropertyToDefault</a></td> <td class="imsum_right">Sets the property to default value. </td> </tr> <tr> <td class="imsum_left"><a href="#getPropertyDefault">getPropertyDefault</a></td> <td class="imsum_right"> </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="getPropertyState" class="membertitle">getPropertyState</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"><a href="PropertyState.html">PropertyState</a></td> </tr> <tr> <td valign="top"><b>getPropertyState</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the state of the property. </dd> <dt><b>Parameter aPropertyName</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if the property does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPropertyStates" class="membertitle">getPropertyStates</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">sequence< <a href="PropertyState.html">PropertyState</a> ></td> </tr> <tr> <td valign="top"><b>getPropertyStates</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aPropertyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of the states of the properties which are specified by their names. <p>The order of the states is correlating to the order of the given property names. </p> </dd> <dt><b>Parameter aPropertyNames</b></dt> <dd>contains the sequence of property names. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if one property does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPropertyToDefault" class="membertitle">setPropertyToDefault</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>setPropertyToDefault</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> PropertyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets the property to default value. </dd> <dd><p>The value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value. </p> </dd> <dt><b>Parameter aPropertyname</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if the property does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPropertyDefault" class="membertitle">getPropertyDefault</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">any</td> </tr> <tr> <td valign="top"><b>getPropertyDefault</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aPropertyName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the default value of the property with the name PropertyName. <p>If no default exists, is not known or is void, then the return type is <code>void</code>. </dd> <dt><b>Parameter aPropertyName</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>UnknownPropertyException if the property does not exist. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if the implementation has an internal reason for the exception. In this case the original exception is wrapped into that ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, 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.</p> </div> <!-- id="adc-idlref" --> </body> </html>