This service specifies a data-aware list box control model. More...
import"DatabaseListBox.idl";
Inheritance diagram for DatabaseListBox:
Included Services | |
| service | com::sun::star::form::component::ListBox |
| service | com::sun::star::form::DataAwareControlModel |
 Included Services inherited from ListBox | |
| service | com::sun::star::awt::UnoControlListBoxModel |
| service | com::sun::star::form::FormControlModel |
| Included Services inherited from UnoControlListBoxModel | |
| service | com::sun::star::awt::UnoControlModel |
| Included Services inherited from UnoControlModel | |
| service | com::sun::star::awt::UnoControlDialogElement |
| This service is present when the control model is embedded in an UnoControlDialogModel. More... | |
| Included Services inherited from FormControlModel | |
| service | com::sun::star::awt::UnoControlModel |
| service | com::sun::star::form::FormComponent |
| Included Services inherited from DataAwareControlModel | |
| service | com::sun::star::form::FormControlModel |
Public Attributes | |
| short | BoundColumn |
| specifies which column of the list result set should be used for data exchange. More... | |
| com::sun::star::form::ListSourceType | ListSourceType |
| describes the kind of list source used. More... | |
| sequence< any > | SelectedValues |
| The selected values. More... | |
| any | SelectedValue |
| The selected value, if there is at most one. More... | |
| Public Attributes inherited from ListBox | |
| sequence< short > | DefaultSelection |
| contains the indexes of entries of the listbox, which should selected by default. More... | |
| sequence< string > | ListSource |
| contains the values associated to the strings to be displayed (which are specified by com::sun::star::awt::UnoControlListBoxModel::StringItemList) More... | |
| Public Attributes inherited from UnoControlListBoxModel | |
| short | Align |
| specifies the horizontal alignment of the text in the control. More... | |
| com::sun::star::util::Color | BackgroundColor |
| specifies the background color (RGB) of the control. More... | |
| short | Border |
| specifies the border style of the control. More... | |
| long | BorderColor |
| specifies the color of the border, if present More... | |
| boolean | Dropdown |
| specifies if the control has a drop down button. More... | |
| boolean | Enabled |
| determines whether the control is enabled or disabled. More... | |
| com::sun::star::awt::FontDescriptor | FontDescriptor |
| specifies the font attributes of the text in the control. More... | |
| short | FontEmphasisMark |
| specifies the com::sun::star::text::FontEmphasis value of the text in the control. More... | |
| short | FontRelief |
| specifies the com::sun::star::text::FontRelief value of the text in the control. More... | |
| string | HelpText |
| specifies the help text of the control. More... | |
| string | HelpURL |
| specifies the help URL of the control. More... | |
| short | LineCount |
| specifies the maximum line count displayed in the drop down box. More... | |
| boolean | MultiSelection |
| specifies if more than one entry can be selected. More... | |
| boolean | Printable |
| specifies that the control will be printed with the document. More... | |
| boolean | ReadOnly |
| specifies that the content of the control cannot be modified by the user. More... | |
| sequence< short > | SelectedItems |
| specifies the sequence of selected items, identified by the position. More... | |
| sequence< string > | StringItemList |
| specifies the list of items. More... | |
| boolean | Tabstop |
| specifies that the control can be reached with the TAB key. More... | |
| com::sun::star::util::Color | TextColor |
| specifies the text color (RGB) of the control. More... | |
| com::sun::star::util::Color | TextLineColor |
| specifies the text line color (RGB) of the control. More... | |
| short | WritingMode |
| denotes the writing mode used in the control, as specified in the com::sun::star::text::WritingMode2 constants group. More... | |
| short | MouseWheelBehavior |
| defines how the mouse wheel can be used to scroll through the control's content. More... | |
| short | ItemSeparatorPos |
| specifies where an item separator - a horizontal line - is drawn. More... | |
| sequence< any > | TypedItemList |
| specifies the list of raw typed (not stringized) items. More... | |
| com::sun::star::util::Color | HighlightColor |
| specifies the background color (RGB) of selected items in the control which are highlighted. More... | |
| com::sun::star::util::Color | HighlightTextColor |
| specifies the text color (RGB) of selected items in the control which are highlighted. More... | |
| Public Attributes inherited from UnoControlModel | |
| string | DefaultControl |
| specifies the service name of the default control for this model. More... | |
| Public Attributes inherited from FormControlModel | |
| short | ClassId |
| specifies the ID for classification of the component. More... | |
| short | TabIndex |
| determines the relative taborder of the control associated with the model. More... | |
| string | Tag |
| used for additional information. More... | |
| Public Attributes inherited from FormComponent | |
| string | Name |
| the name of the component. More... | |
| Public Attributes inherited from DataAwareControlModel | |
| string | DataField |
| specifies the name of the bound database field. More... | |
| boolean | InputRequired |
| determines whether or not input into this field is required, when it is actually bound to a database field. More... | |
| com::sun::star::beans::XPropertySet | BoundField |
| references to the cursor field to which the control is bound. More... | |
| com::sun::star::beans::XPropertySet | LabelControl |
| references to a control model within the same document which should be used as a label. More... | |
Additional Inherited Members | |
| Exported Interfaces inherited from ListBox | |
| interface | com::sun::star::form::XReset |
| can be used to reset the control to its default state. More... | |
| Exported Interfaces inherited from UnoControlListBoxModel | |
| interface | XItemList |
| allows manipulating the list of items in the list box more fine-grained than the StringItemList property. More... | |
| Exported Interfaces inherited from UnoControlModel | |
| interface | com::sun::star::awt::XControlModel |
| interface | com::sun::star::lang::XComponent |
| interface | com::sun::star::beans::XPropertySet |
| interface | com::sun::star::beans::XMultiPropertySet |
| interface | com::sun::star::io::XPersistObject |
| interface | com::sun::star::util::XCloneable |
| Exported Interfaces inherited from FormControlModel | |
| interface | com::sun::star::beans::XFastPropertySet |
| This optional interface gives an efficient access to all properties at once or an ability to set more than one property at once. More... | |
| interface | com::sun::star::beans::XPropertyState |
| This optional interface gives access to the state of the properties, e.g. More... | |
| Exported Interfaces inherited from FormComponent | |
| interface | com::sun::star::form::XFormComponent |
| identifies the component as a candidate for being part of a form. More... | |
| interface | com::sun::star::lang::XComponent |
| allows life-time control of form components. More... | |
| interface | com::sun::star::container::XNamed |
| Each FormComponent must supply a name for identification. More... | |
| interface | com::sun::star::beans::XPropertySet |
| gives access to the properties. More... | |
| interface | com::sun::star::io::XPersistObject |
| Each FormComponent must be able to be stored into and read from a stream. More... | |
| interface | com::sun::star::beans::XPropertyBag |
| allows to associate arbitrary properties with the form component More... | |
| Exported Interfaces inherited from XPropertyBag | |
| interface | com::sun::star::beans::XPropertySet |
| interface | com::sun::star::beans::XPropertyContainer |
| interface | com::sun::star::beans::XPropertyAccess |
| Exported Interfaces inherited from DataAwareControlModel | |
| interface | com::sun::star::form::XBoundComponent |
| makes it possible to transfer the data of the model to the connected data field. More... | |
| interface | com::sun::star::form::XLoadListener |
| must be implemented in order to recognize when the containing form of the model connects to its data source (loads its data). More... | |
| interface | com::sun::star::form::XReset |
| Each DataAwareControlModel should be resettable for setting default values. More... | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
| Public Member Functions inherited from XComponent | |
| void | dispose () |
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
| void | addEventListener ([in] XEventListener xListener) |
| adds an event listener to the object. More... | |
| void | removeEventListener ([in] XEventListener aListener) |
| removes an event listener from the listener list. More... | |
| Public Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More... | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More... | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More... | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More... | |
| Public Member Functions inherited from XMultiPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the values to the properties with the specified names. More... | |
| sequence< any > | getPropertyValues ([in] sequence< string > aPropertyNames) |
| void | addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| adds an XPropertiesChangeListener to the specified property with the specified names. More... | |
| void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| removes an XPropertiesChangeListener from the listener list. More... | |
| void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| fires a sequence of PropertyChangeEvents to the specified listener. More... | |
| Public Member Functions inherited from XPersistObject | |
| string | getServiceName () |
| gives the service name of the object More... | |
| void | write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException ) |
| writes all the persistent data of the object to the stream. More... | |
| void | read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException ) |
| reads all the persistent data of the object from the stream. More... | |
| Public Member Functions inherited from XCloneable | |
| com::sun::star::util::XCloneable | createClone () |
| creates a copy of the object. More... | |
| Public Member Functions inherited from XChild | |
| com::sun::star::uno::XInterface | getParent () |
| grants access to the object containing this content. More... | |
| void | setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException ) |
| sets the parent to this object. More... | |
| Public Member Functions inherited from XNamed | |
| string | getName () |
| void | setName ([in] string aName) |
| sets the programmatic name of the object. More... | |
| Public Member Functions inherited from XReset | |
| void | reset () |
| resets a component to some default value. More... | |
| void | addResetListener ([in] com::sun::star::form::XResetListener aListener) |
| adds the specified listener to receive events related to resetting the component. More... | |
| void | removeResetListener ([in] com::sun::star::form::XResetListener aListener) |
| removes the specified listener More... | |
| Public Member Functions inherited from XLoadListener | |
| void | loaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object has successfully connected to a datasource. More... | |
| void | unloading ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object is about to be unloaded. More... | |
| void | unloaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked after the object has disconnected from a datasource. More... | |
| void | reloading ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object is about to be reloaded. More... | |
| void | reloaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object has been reloaded. More... | |
| Public Member Functions inherited from XEventListener | |
| void | disposing ([in] com::sun::star::lang::EventObject Source) |
| gets called when the broadcaster is about to be disposed. More... | |
| Protected Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
| Protected Member Functions inherited from XComponent | |
| void | dispose () |
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
| void | addEventListener ([in] XEventListener xListener) |
| adds an event listener to the object. More... | |
| void | removeEventListener ([in] XEventListener aListener) |
| removes an event listener from the listener list. More... | |
| Protected Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value of the property with the specified name. More... | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XPropertyChangeListener to the specified property. More... | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XPropertyChangeListener from the listener list. More... | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| removes an XVetoableChangeListener from the listener list. More... | |
| Protected Member Functions inherited from XMultiPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
| void | setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the values to the properties with the specified names. More... | |
| sequence< any > | getPropertyValues ([in] sequence< string > aPropertyNames) |
| void | addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| adds an XPropertiesChangeListener to the specified property with the specified names. More... | |
| void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| removes an XPropertiesChangeListener from the listener list. More... | |
| void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) |
| fires a sequence of PropertyChangeEvents to the specified listener. More... | |
| Protected Member Functions inherited from XPersistObject | |
| string | getServiceName () |
| gives the service name of the object More... | |
| void | write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException ) |
| writes all the persistent data of the object to the stream. More... | |
| void | read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException ) |
| reads all the persistent data of the object from the stream. More... | |
| Protected Member Functions inherited from XCloneable | |
| com::sun::star::util::XCloneable | createClone () |
| creates a copy of the object. More... | |
| Protected Member Functions inherited from XItemList | |
| void | insertItem ([in] long Position, [in] string ItemText, [in] string ItemImageURL) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| inserts a new item into the list More... | |
| void | insertItemText ([in] long Position, [in] string ItemText) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| inserts an item which has only a text, but no image More... | |
| void | insertItemImage ([in] long Position, [in] string ItemImageURL) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| inserts an item which has only an image, but no text More... | |
| void | removeItem ([in] long Position) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| removes an item from the list More... | |
| void | removeAllItems () |
| removes all items from the list More... | |
| void | setItemText ([in] long Position, [in] string ItemText) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| sets a new text for an existing item More... | |
| void | setItemImage ([in] long Position, [in] string ItemImageURL) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| sets a new image for an existing item More... | |
| void | setItemTextAndImage ([in] long Position, [in] string ItemText, [in] string ItemImageURL) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| sets both a new position and text for an existing item More... | |
| void | setItemData ([in] long Position, [in] any ItemData) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| associates an implementation dependent value with the given list item. More... | |
| string | getItemText ([in] long Position) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| retrieves the text of an existing item More... | |
| string | getItemImage ([in] long Position) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| retrieves the URL of the image of an existing item More... | |
| ::com::sun::star::beans::Pair< string, string > | getItemTextAndImage ([in] long Position) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| retrieves both the text and the image URL of an existing item More... | |
| any | getItemData ([in] long Position) raises ( ::com::sun::star::lang::IndexOutOfBoundsException ) |
| retrieves the implementation dependent value associated with the given list item. More... | |
| sequence< ::com::sun::star::beans::Pair< string, string > > | getAllItems () |
| retrieves the texts and images of all items in the list More... | |
| void | addItemListListener ([in] XItemListListener Listener) |
| registers a listener which is notified about changes in the item list. More... | |
| void | removeItemListListener ([in] XItemListListener Listener) |
| revokes a listener which is notified about changes in the item list. More... | |
| Protected Member Functions inherited from XPropertyContainer | |
| void | addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException ) |
| adds a property to the object. More... | |
| void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException ) |
| removes a property from the object. More... | |
| Protected Member Functions inherited from XPropertyAccess | |
| sequence< com::sun::star::beans::PropertyValue > | getPropertyValues () |
| void | setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the values of given properties. More... | |
| Protected Member Functions inherited from XFastPropertySet | |
| void | setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
| sets the value to the property with the specified name. More... | |
| any | getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| Protected Member Functions inherited from XPropertyState | |
| com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| sequence< com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException ) |
| Sets the property to default value. More... | |
| any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
| Protected Member Functions inherited from XBoundComponent | |
| boolean | commit () |
| commits the content of the component into the data source it is bound to. More... | |
| Protected Member Functions inherited from XUpdateBroadcaster | |
| void | addUpdateListener ([in] com::sun::star::form::XUpdateListener aListener) |
| adds the specified listener to receive the events "approveUpdate" and "updated". More... | |
| void | removeUpdateListener ([in] com::sun::star::form::XUpdateListener aListener) |
| removes the specified listener. More... | |
| Protected Member Functions inherited from XLoadListener | |
| void | loaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object has successfully connected to a datasource. More... | |
| void | unloading ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object is about to be unloaded. More... | |
| void | unloaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked after the object has disconnected from a datasource. More... | |
| void | reloading ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object is about to be reloaded. More... | |
| void | reloaded ([in] com::sun::star::lang::EventObject aEvent) |
| is invoked when the object has been reloaded. More... | |
| Protected Member Functions inherited from XEventListener | |
| void | disposing ([in] com::sun::star::lang::EventObject Source) |
| gets called when the broadcaster is about to be disposed. More... | |
| Protected Attributes inherited from UnoControlDialogElement | |
| long | Height |
| specifies the height of the control. More... | |
| string | Name |
| specifies the name of the control. More... | |
| string | PositionX |
| specifies the horizontal position of the control. More... | |
| string | PositionY |
| specifies the vertical position of the control. More... | |
| long | Step |
| specifies the step of the control. More... | |
| short | TabIndex |
| specifies the tabindex of the control. More... | |
| string | Tag |
| specifies the tag of the control. More... | |
| long | Width |
| specifies the width of the control. More... | |
| Protected Attributes inherited from XItemList | |
| long | ItemCount |
| is the number of items in the list More... | |
Detailed 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.
Exported Interfaces
◆ com::sun::star::form::component::ListBox
◆ com::sun::star::form::DataAwareControlModel
Member Data Documentation
◆ BoundColumn
|
property |
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
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, lose 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.
◆ SelectedValue
|
optionalpropertytransient |
The selected value, if there is at most one.
◆ SelectedValues
|
optionalpropertytransient |
The selected values.
The documentation for this service was generated from the following file:
- com/sun/star/form/component/DatabaseListBox.idl
