Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 3237

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Service DatabaseListBox</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="DatabaseListBox-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">Interfaces' Summary</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">Interfaces' Details</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 DatabaseListBox</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This service specifies a data-aware list box control model.

 </dd>
<dd><p>The base service for list boxes (<a href="ListBox.html">ListBox</a>) offers only
 one possibility to specify the list entries: the <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 property, which contains all the strings to be displayed.</p>

 <p>This service here extends this mimic. It allows to fill the list from a data source.
 This means that a second result set is opened, which works on the same connection as the
 form which the list box belongs to, but can be based on an arbitrary table or SQL statement.</p>

 <p>For instance, you may have a form which is bound to a table <em>invoice</em>, and you use it
 to enter invoices for your customers. Probably, you will have a second table (say <em>customer</em>),
 which (amonst other data) contains a unique key for identifying customers. In your invoice table, you will
 have a foreign key referring to these customers.<br/>
 Now, besides the result set the form is based on (all your invoices), the list box can be caused
 to open a second result set, this time for the <em>customer</em> table, and fill it's list with entries
 from this result set.<br/>
 Additionally, it allows to model the relation between the two tables: When the user selects a customer from
 the list, this customer has the unique id we just talked about (which is not necessarily visible to the
 user in any way). The list box then automatically transfers this id into the foreign key column of
 <em>invoice</em>, thus allowing the user to transparently work with human-readable strings instead of
 pure numbers.<br/>
 Let's call this result set the list is filled from the <em>list result set</em> here ...</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"><a href="ListBox.html">ListBox</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>specifies a model for a control which allows to choose in a list of alternative values.
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../DataAwareControlModel.html">DataAwareControlModel</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>is an abstract service for specialized ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a>s
 which are data aware and thus can be bound to a data source.

 </dd>
</dl>
</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="#BoundColumn">BoundColumn</a></td>
<td class="imsum_right">specifies which column of the list result set should be used for data exchange.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a><br>
<a href="#ListSourceType">ListSourceType</a></td>
<td class="imsum_right">describes the kind of list source used.

 &nbsp;</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="ListBox" class="membertitle"><a href="ListBox.html">ListBox</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 model for a control which allows to choose in a list of alternative values.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="DataAwareControlModel" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../DataAwareControlModel.html">DataAwareControlModel</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>is an abstract service for specialized ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a>s
 which are data aware and thus can be bound to a data source.

 </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="BoundColumn" class="membertitle">BoundColumn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>BoundColumn</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies which column of the list result set should be used for data exchange.

 </dd>
<dd><p>When you make a selection from a list box, the "BoundColumn"
 property reflects which column value of a result set should
 be used as the value of the component. If the control is bound
 to a database field, the column value is stored in the
 database field identified by the property
 ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../DataAwareControlModel.html">DataAwareControlModel</a>::<a href="../DataAwareControlModel.html#DataField">DataField</a>.
 
 <dl>
 <dt>0</dt>
 <dd>The selected (displayed) list box string is stored in
 the current database field.</dd>

 <dt>1 or greater</dt>
 <dd>The column value of the result set at the position is
 stored in the current database field.</dd>
 </dl></p>

 <p>The bound column property is only used if a list source is defined
 and the list source matches with the types
 ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#TABLE">TABLE</a>,
 ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#QUERY">QUERY</a>,
 ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#SQL">SQL</a> or
 ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#SQLPASSTHROUGH">SQLPASSTHROUGH</a>.
 Otherwise the property is ignored, as there is no result set from which to
 get the column values.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ListSourceType" class="membertitle">ListSourceType</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="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a> <b>ListSourceType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>describes the kind of list source used.

 </dd>
<dd><p>Depending on the value of this property, the way the value of <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 is evaluated varies.
 <dl>
 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#VALUELIST">VALUELIST</a></dt>
 <dd>The elements in the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 build up the entry list.</dd>

 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#TABLE">TABLE</a></dt>
 <dd>The first element of the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 determines the table which the list result set should be based on.</dd>

 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#QUERY">QUERY</a></dt>
 <dd>The first element of the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 determines the query which the list result set should be based on.<br/>
 For retrieving the query, the connection which the data form is working with
 (::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>::<a href="../../sdb/RowSet.html#ActiveConnection">ActiveConnection</a>) is queried for
 the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/XQueriesSupplier.html">XQueriesSupplier</a> interface.</dd>

 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#SQL">SQL</a></dt>
 <dd>The first element of the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 contains the SQL statement which the list result set should be based on.</p>

 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#SQLPASSTHROUGH">SQLPASSTHROUGH</a></dt>
 <dd>The first element of the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 contains the SQL statement which the list result set should be based on.<br/>
 The statement is not analyzed by the parser. This means that you can use database specific
 SQL features here, but, on the other hand, loose features like parameter value substitution.</dd>

 <dt>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../ListSourceType.html">ListSourceType</a>::<a href="../ListSourceType.html#TABLEFIELDS">TABLEFIELDS</a></dt>
 <dd>The first element of the string sequence in <a href="ListBox.html">ListBox</a>::<a href="ListBox.html#ListSource">ListSource</a>
 determines the table which's column names should fill the list.</dd>
 </dl>
 </p>

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 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>