<html> <head> <title>Service GridControl</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="GridControl-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">form</a> :: <a href="module-ix.html" class="namechain">component</a> :: </p> </td> </tr> <tr> <td class="title">service GridControl</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a model for a control which can display form data in a table-like way. </dd> <dd><p>In opposite to other form controls, grid controls do not only display the single current value of a column they are bound to. Moreover, they do display not only the current row of the form, but all rows (at least potentially, limited by the control size, of course).</p> <p>The table rows in a grid control correspond to the rows in the <a href="DataForm.html">DataForm</a> the control belongs to, and the columns correspond to single columns of the form's row set.</p> <p>Columns of a grid control are modeled by own objects, too. They are very similar to usual ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../DataAwareControlModel.html">DataAwareControlModel</a>s modeling other "single-value" controls, but they are not described as own services. Instead, they need to be created using the ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridColumnFactory.html">XGridColumnFactory</a> interface.</p> </dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a control model within a form. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponents.html">FormComponents</a></td> <td class="imsum_right"><p>provides basic functionality of a container of ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponent.html">FormComponent</a>s. (<a href="#FormComponents">details</a>)</p> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridColumnFactory.html">XGridColumnFactory</a></td> <td class="imsum_right"><p>allows to create column models to be inserted into the control model. (<a href="#XGridColumnFactory">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XSelectionSupplier.html">XSelectionSupplier</a></td> <td class="imsum_right"><p>gives access to the currently selection. (<a href="#XSelectionSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></td> <td class="imsum_right"><p>resets the control. (<a href="#XReset">details</a>)</p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Border">Border</a></td> <td class="imsum_right">returns the border style of the control. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BorderColor">BorderColor</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the color of the border, if present </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Enabled">Enabled</a></td> <td class="imsum_right">determines whether the control is enabled or disabled. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/FontDescriptor.html">FontDescriptor</a><br> <a href="#FontDescriptor">FontDescriptor</a></td> <td class="imsum_right">contains the font attributes of the text in the control. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#RowHeight">RowHeight</a></td> <td class="imsum_right">specifies the height of a row of the grid. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Tabstop">Tabstop</a></td> <td class="imsum_right">determines whether the control can be reached by the tabulator key. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/Color.html">Color</a><br> <a href="#TextColor">TextColor</a></td> <td class="imsum_right">specifies the text color (RGB) of the control. </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="FormControlModel" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a control model within a form. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="FormComponents" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponents.html">FormComponents</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides basic functionality of a container of ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponent.html">FormComponent</a>s. </dd> <dd><p>All the container-related methods of this service related to control models, this is what are the container elements for a <a href="GridControl.html">GridControl</a>.</p> <p>As the ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponents.html">FormComponents</a> service also specifies the ::com::sun::star::<a href="../../script/module-ix.html">script</a>::<a href="../../script/XEventAttacherManager.html">XEventAttacherManager</a> service, grid control models also provide a scripting environment for their columns.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XGridColumnFactory" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridColumnFactory.html">XGridColumnFactory</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to create column models to be inserted into the control model. </dd> <dd><p>Note that the object returned by the ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridColumnFactory.html">XGridColumnFactory</a>::<a href="../XGridColumnFactory.html#createColumn">createColumn</a> method is not part of the grid control, yet. It needs to be inserted using any of the container interfaces.</p> <p>You always need to use this interface for creating columns for the grid control. Column models not created this way will not be accepted when inserted later on.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XSelectionSupplier" class="membertitle">::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XSelectionSupplier.html">XSelectionSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>gives access to the currently selection. </dd> <dd><p>In a grid control, single columns can be selected (at most one at a time).<br/> For various unfortunate reasons, this selection is an aspect of the model, not of the control as you would expect.</p> <p>This interface is deprecated, new implementations should not use it anymore, as it is to be superseded by a solution which is bound to the control, not the model.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XReset" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>resets the control. </dd> <dd><p>The reset of the control is forwarded to all it's elements, means to all the column models. As grid columns are very much like data-aware stand-alone controls, you can find a description of the reset functionality in ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../DataAwareControlModel.html">DataAwareControlModel</a>::<a href="../DataAwareControlModel.html#XReset">XReset</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Border" class="membertitle">Border</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Border</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>returns the border style of the control. </dd> <dd><pre> 0: No border 1: 3D border 2: simple border </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BorderColor" class="membertitle">BorderColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BorderColor</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the color of the border, if present </dd> <dd><p>Not every border style (see <a href="#Border">Border</a>) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Enabled" class="membertitle">Enabled</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Enabled</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control is enabled or disabled. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontDescriptor" class="membertitle">FontDescriptor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/FontDescriptor.html">FontDescriptor</a> <b>FontDescriptor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the font attributes of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RowHeight" class="membertitle">RowHeight</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>RowHeight</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the height of a row of the grid. </dd> <dd><p>If the value is set to <b>NULL</b>, the height is determined automatically according to the current font used.</p> </dd> <dt><b>See also</b></dt> <dd><a href="GridControl.html">GridControl</a>::<a href="GridControl.html#FontDescriptor">FontDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Tabstop" class="membertitle">Tabstop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Tabstop</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control can be reached by the tabulator key. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextColor" class="membertitle">TextColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/Color.html">Color</a> <b>TextColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>
