| LibreOffice
    LibreOffice 25.2 SDK API Reference | 
This service specifies a radio button which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. More...
import "BindableDatabaseRadioButton.idl";
 
  
| Included Services | |
| service | com::sun::star::form::component::DatabaseRadioButton | 
| service | com::sun::star::form::binding::BindableDataAwareControlModel | 
| specifies the interaction between an internal binding to a database column, and an external value binding. | |
| Included Services inherited from DatabaseRadioButton | |
| service | com::sun::star::form::component::RadioButton | 
| service | com::sun::star::form::DataAwareControlModel | 
| Included Services inherited from RadioButton | |
| service | com::sun::star::awt::UnoControlRadioButtonModel | 
| service | com::sun::star::form::FormControlModel | 
| Included Services inherited from UnoControlRadioButtonModel | |
| 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. | |
| 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 | 
| Included Services inherited from BindableDataAwareControlModel | |
| service | com::sun::star::form::DataAwareControlModel | 
| specifies the functionality for binding the control model to a column of an SQL com::sun::star::form::component::DataForm. | |
| service | BindableControlModel | 
| specifies the functionality for alternatively binding the control model to an external value. | |
| Included Services inherited from BindableControlModel | |
| service | com::sun::star::form::FormControlModel | 
| specifies the basic functionality for a form control model | |
| Public Attributes | |
| string | SecondaryRefValue | 
| specifies a value which is to be associated with the control when it's not selected. | |
| Public Attributes inherited from RadioButton | |
| short | DefaultState | 
| contains a default value for the control. | |
| string | RefValue | 
| contains a reference value which is used for submission in a HTML form. | |
| string | UncheckedRefValue | 
| specifies a value which is to be associated with the control when it's not selected. | |
| Public Attributes inherited from UnoControlRadioButtonModel | |
| short | Align | 
| specifies the horizontal alignment of the text in the control. | |
| long | BackgroundColor | 
| specifies the background color (RGB) of the control. | |
| boolean | Enabled | 
| determines whether the control is enabled or disabled. | |
| com::sun::star::awt::FontDescriptor | FontDescriptor | 
| specifies the font attributes of the text in the control. | |
| short | FontEmphasisMark | 
| specifies the com::sun::star::text::FontEmphasis value of the text in the control. | |
| short | FontRelief | 
| specifies the com::sun::star::text::FontRelief value of the text in the control. | |
| string | HelpText | 
| specifies the help text of the control. | |
| string | HelpURL | 
| specifies the help URL of the control. | |
| short | ImagePosition | 
| specifies the position of the image, if any, relative to the text, if any | |
| string | ImageURL | 
| specifies a URL to an image to display besides the label of the control | |
| com::sun::star::graphic::XGraphic | Graphic | 
| specifies a graphic to be displayed besides the label of the control | |
| string | Label | 
| specifies the label of the control. | |
| boolean | MultiLine | 
| specifies that the text may be displayed on more than one line. | |
| boolean | Printable | 
| specifies that the control will be printed with the document. | |
| short | State | 
| specifies the state of the control. | |
| boolean | Tabstop | 
| specifies that the control can be reached with the TAB key. | |
| com::sun::star::util::Color | TextColor | 
| specifies the text color (RGB) of the control. | |
| com::sun::star::util::Color | TextLineColor | 
| specifies the text line color (RGB) of the control. | |
| com::sun::star::style::VerticalAlignment | VerticalAlign | 
| specifies the vertical alignment of the text in the control. | |
| short | VisualEffect | 
| specifies a visual effect to apply to the radio button control. | |
| short | WritingMode | 
| denotes the writing mode used in the control, as specified in the com::sun::star::text::WritingMode2 constants group. | |
| Public Attributes inherited from UnoControlModel | |
| string | DefaultControl | 
| specifies the service name of the default control for this model. | |
| Public Attributes inherited from FormControlModel | |
| short | ClassId | 
| specifies the ID for classification of the component. | |
| short | TabIndex | 
| determines the relative taborder of the control associated with the model. | |
| string | Tag | 
| used for additional information. | |
| Public Attributes inherited from FormComponent | |
| string | Name | 
| the name of the component. | |
| Public Attributes inherited from DataAwareControlModel | |
| string | DataField | 
| specifies the name of the bound database field. | |
| boolean | InputRequired | 
| determines whether or not input into this field is required, when it is actually bound to a database field. | |
| com::sun::star::beans::XPropertySet | BoundField | 
| references to the cursor field to which the control is bound. | |
| com::sun::star::beans::XPropertySet | LabelControl | 
| references to a control model within the same document which should be used as a label. | |
| Additional Inherited Members | |
| Exported Interfaces inherited from RadioButton | |
| interface | com::sun::star::form::XReset | 
| can be used to reset the control to its default text. | |
| 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. | |
| interface | com::sun::star::beans::XPropertyState | 
| This optional interface gives access to the state of the properties, e.g. | |
| Exported Interfaces inherited from FormComponent | |
| interface | com::sun::star::form::XFormComponent | 
| identifies the component as a candidate for being part of a form. | |
| interface | com::sun::star::lang::XComponent | 
| allows life-time control of form components. | |
| interface | com::sun::star::container::XNamed | 
| Each FormComponent must supply a name for identification. | |
| interface | com::sun::star::beans::XPropertySet | 
| gives access to the properties. | |
| interface | com::sun::star::io::XPersistObject | 
| Each FormComponent must be able to be stored into and read from a stream. | |
| interface | com::sun::star::beans::XPropertyBag | 
| allows to associate arbitrary properties with the form component | |
| 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. | |
| 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). | |
| interface | com::sun::star::form::XReset | 
| Each DataAwareControlModel should be resettable for setting default values. | |
| Exported Interfaces inherited from BindableControlModel | |
| interface | XBindableValue | 
| specifies support for being bound to an external value | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
| 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. | |
| void | addEventListener ([in] XEventListener xListener) | 
| adds an event listener to the object. | |
| void | removeEventListener ([in] XEventListener aListener) | 
| removes an event listener from the listener list. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) | 
| removes an XPropertiesChangeListener from the listener list. | |
| void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) | 
| fires a sequence of PropertyChangeEvents to the specified listener. | |
| Public Member Functions inherited from XPersistObject | |
| string | getServiceName () | 
| gives the service name of the object | |
| 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. | |
| 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. | |
| Public Member Functions inherited from XCloneable | |
| com::sun::star::util::XCloneable | createClone () | 
| creates a copy of the object. | |
| Public Member Functions inherited from XChild | |
| com::sun::star::uno::XInterface | getParent () | 
| grants access to the object containing this content. | |
| void | setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException ) | 
| sets the parent to this object. | |
| Public Member Functions inherited from XNamed | |
| string | getName () | 
| void | setName ([in] string aName) | 
| sets the programmatic name of the object. | |
| Public Member Functions inherited from XReset | |
| void | reset () | 
| resets a component to some default value. | |
| void | addResetListener ([in] com::sun::star::form::XResetListener aListener) | 
| adds the specified listener to receive events related to resetting the component. | |
| void | removeResetListener ([in] com::sun::star::form::XResetListener aListener) | 
| removes the specified listener | |
| 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. | |
| void | unloading ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object is about to be unloaded. | |
| void | unloaded ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked after the object has disconnected from a datasource. | |
| void | reloading ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object is about to be reloaded. | |
| void | reloaded ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object has been reloaded. | |
| 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. | |
| Public Member Functions inherited from XBindableValue | |
| void | setValueBinding ([in] XValueBinding aBinding) raises ( IncompatibleTypesException ) | 
| sets an external instance which controls the value of the component | |
| XValueBinding | getValueBinding () | 
| retrieves the external instance which currently controls the value of the component | |
| Protected Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
| 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. | |
| void | addEventListener ([in] XEventListener xListener) | 
| adds an event listener to the object. | |
| void | removeEventListener ([in] XEventListener aListener) | 
| removes an event listener from the listener list. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) | 
| removes an XPropertiesChangeListener from the listener list. | |
| void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener) | 
| fires a sequence of PropertyChangeEvents to the specified listener. | |
| Protected Member Functions inherited from XPersistObject | |
| string | getServiceName () | 
| gives the service name of the object | |
| 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. | |
| 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. | |
| Protected Member Functions inherited from XCloneable | |
| com::sun::star::util::XCloneable | createClone () | 
| creates a copy of the object. | |
| 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. | |
| void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException ) | 
| removes a property from the object. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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". | |
| void | removeUpdateListener ([in] com::sun::star::form::XUpdateListener aListener) | 
| removes the specified listener. | |
| 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. | |
| void | unloading ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object is about to be unloaded. | |
| void | unloaded ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked after the object has disconnected from a datasource. | |
| void | reloading ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object is about to be reloaded. | |
| void | reloaded ([in] com::sun::star::lang::EventObject aEvent) | 
| is invoked when the object has been reloaded. | |
| 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. | |
| Protected Attributes inherited from UnoControlDialogElement | |
| long | Height | 
| specifies the height of the control. | |
| string | Name | 
| specifies the name of the control. | |
| string | PositionX | 
| specifies the horizontal position of the control. | |
| string | PositionY | 
| specifies the vertical position of the control. | |
| long | Step | 
| specifies the step of the control. | |
| short | TabIndex | 
| specifies the tabindex of the control. | |
| string | Tag | 
| specifies the tag of the control. | |
| long | Width | 
| specifies the width of the control. | |
This service specifies a radio button which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values.
The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseRadioButton must support exchanging boolean values. The following mapping between external values and control states apply:
If the value binding associated with a BindableDatabaseRadioButton supports exchanging string values, and the com::sun::star::form::component::RadioButton::RefValue is not empty, then the radio button will exchange its value as string:
specifies the interaction between an internal binding to a database column, and an external value binding.
| 
 | property | 
specifies a value which is to be associated with the control when it's not selected.
com::sun::star::form::component::RadioButton::RefValue is transferred to possible external value bindings as soon as the radio button is selected. With the member SecondaryRefValue, clients of the radio button can also associate a value with the not selected state of the control.