<html> <head> <title>Interface XControlInformation</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="XControlInformation-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">ui</a> :: <a href="module-ix.html" class="namechain">dialogs</a> :: </p> </td> </tr> <tr> <td class="title">interface XControlInformation</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Interface to query for controls and control properties supported by the implementing instance. </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2</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="#getSupportedControls">getSupportedControls</a></td> <td class="imsum_right">Query for the supported controls of a service instance. </td> </tr> <tr> <td class="imsum_left"><a href="#isControlSupported">isControlSupported</a></td> <td class="imsum_right">Returns whether the specified control is supported or not. </td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedControlProperties">getSupportedControlProperties</a></td> <td class="imsum_right">Returns a sequence with properties supported by the specified control. </td> </tr> <tr> <td class="imsum_left"><a href="#isControlPropertySupported">isControlPropertySupported</a></td> <td class="imsum_right">Returns whether control property is supported by a control. </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="getSupportedControls" class="membertitle">getSupportedControls</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< string ></td> </tr> <tr> <td valign="top"><b>getSupportedControls</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query for the supported controls of a service instance. </dd> <dt><b>Returns</b></dt> <dd>a sequence with the names of the supported controls. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isControlSupported" class="membertitle">isControlSupported</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>isControlSupported</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aControlName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns whether the specified control is supported or not. </dd> <dt><b>Parameter aControlName</b></dt> <dd>The name of the control. Common control names are for instance "OkButton" or "CancelButton". </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the specified control is supported. <b>false</b> if the specified control is not supported. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSupportedControlProperties" class="membertitle">getSupportedControlProperties</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< string ></td> </tr> <tr> <td valign="top"><b>getSupportedControlProperties</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aControlName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns a sequence with properties supported by the specified control. </dd> <dt><b>Parameter aControlName</b></dt> <dd>The name of the control. Common control names are for instance "OkButton" or "CancelButton". </dd> <dt><b>Returns</b></dt> <dd>a sequence of control properties supported by the specified control. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException when the specified control is not supported. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isControlPropertySupported" class="membertitle">isControlPropertySupported</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>isControlPropertySupported</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aControlName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aControlProperty )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns whether control property is supported by a control. </dd> <dt><b>Parameter aControlName</b></dt> <dd>The name of the control. </dd> <dt><b>Parameter aControlProperty</b></dt> <dd>The control property to query for. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the specified control action is supported. <b>false</b> if the specified control action is not supported. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException when the specified control is not supported. </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>
