Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: form :: component ::
service DatabaseListBox
Description This service specifies a data-aware list box control model. The base service for list boxes (ListBox) offers only one possibility to specify the list entries: The display strings in the ::com::sun::star::awt::UnoControlListBoxModel::StringItemList property and the corresponding values in the ListBox::ListSource property. 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. For instance, you may have a form which is bound to a table invoice, and you use it to enter invoices for your customers. Probably, you will have a second table (say customer), which (among other data) contains a unique key for identifying customers. In your invoice table, you will have a foreign key referring to these customers. Now, besides the result set the form is based on (all your invoices), the list box can be instructed to open a second result set, this time for the customer table, and fill its list with entries from this result set. 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 invoice, thus allowing the user to transparently work with human-readable strings instead of pure numbers. Let's call this result set the list is filled from the list result set here ... The display strings are always taken from the first column of that result set, and the corresponding value as per the BoundColumn property.

Included Services - Summary
ListBox | (referenced entity's summary:) specifies a model for a control which allows to choose in a list of alternative values.
::com::sun::star::form::DataAwareControlModel | (referenced entity's summary:) is an abstract service for specialized ::com::sun::star::form::FormControlModels which are data aware and thus can be bound to a data source.

Properties' Summary
short BoundColumn | specifies which column of the list result set should be used for data exchange.
::com::sun::star::form::ListSourceType ListSourceType | describes the kind of list source used.
[ transient ] sequence< any > SelectedValues | [ OPTIONAL ] The selected values.
[ transient ] any SelectedValue | [ OPTIONAL ] The selected value, if there is at most one.

Included Services - Details
ListBox
(referenced entity's summary:) specifies a model for a control which allows to choose in a list of alternative values.
::com::sun::star::form::DataAwareControlModel
(referenced entity's summary:) is an abstract service for specialized ::com::sun::star::form::FormControlModels which are data aware and thus can be bound to a data source.

Properties' Details
BoundColumn
short BoundColumn; Description specifies which column of the list result set should be used for data exchange. 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::form::DataAwareControlModel::DataField. -1 The index (starting at 0) of the selected list box entry is stored in the current database field. 0 or greater The column value of the result set at the position (0-indexed) is stored in the current database field. In particular, for value 0, the selected (displayed) list box string is stored. The bound column property is only used if a list source is defined and the list source matches with the types ::com::sun::star::form::ListSourceType::TABLE, ::com::sun::star::form::ListSourceType::QUERY, ::com::sun::star::form::ListSourceType::SQL or ::com::sun::star::form::ListSourceType::SQLPASSTHROUGH. Otherwise the property is ignored, as there is no result set from which to get the column values.
ListSourceType
::com::sun::star::form::ListSourceType ListSourceType; Description describes the kind of list source used. Depending on the value of this property, the way the value of ListBox::ListSource is evaluated varies. ::com::sun::star::form::ListSourceType::VALUELIST The elements in the string sequence in ListBox::ListSource build up the entry list. ::com::sun::star::form::ListSourceType::TABLE The first element of the string sequence in ListBox::ListSource determines the table which the list result set should be based on. ::com::sun::star::form::ListSourceType::QUERY The first element of the string sequence in ListBox::ListSource determines the query which the list result set should be based on. For retrieving the query, the connection which the data form is working with (::com::sun::star::sdb::RowSet::ActiveConnection) is queried for the ::com::sun::star::sdb::XQueriesSupplier interface. ::com::sun::star::form::ListSourceType::SQL The first element of the string sequence in ListBox::ListSource contains the SQL statement which the list result set should be based on. ::com::sun::star::form::ListSourceType::SQLPASSTHROUGH The first element of the string sequence in ListBox::ListSource contains the SQL statement which the list result set should be based on. 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. ::com::sun::star::form::ListSourceType::TABLEFIELDS The first element of the string sequence in ListBox::ListSource determines the table whose column names should fill the list.
SelectedValues
[ transient ] sequence< any > SelectedValues; Usage Restrictions optional Description The selected values.
SelectedValue
[ transient ] any SelectedValue; Usage Restrictions optional Description The selected value, if there is at most one.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "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 trademark policy.