Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: form :: binding ::

unpublished service BindableDatabaseCheckBox
Usage Restrictions
not published
Description
This service specifies a check box which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values.

The XValueBinding instance which can be associated with a BindableDatabaseCheckBox must support exchanging boolean values. The following mapping between external values and control states apply:

  • true will be mapped to the box being checked, and vice versa
  • false will be mapped to it being unchecked, and vice versa
  • NULL will be mapped to it being in indetermined state, if the box currently supports this, or being unchecked else. The indetermined of the check box will always be mapped to NULL when writing the external value.

If the value binding associated with a BindableDatabaseCheckBox supports exchanging string values, and the ::com::sun::star::form::component::CheckBox::RefValue is not empty, then the radio button will exchange it's value as string:

  • A string equal to the reference value will be mapped to the button being checked, and vice versa
  • A string not equal to the reference value will be mapped to the button being unchecked, and vice versa
  • NULL will be mapped to it being in indetermined state

See also
XValueBinding::supportsType, ::com::sun::star::awt::UnoControlCheckBoxModel::State, ::com::sun::star::awt::UnoControlCheckBoxModel::TriState, ::com::sun::star::form::component::CheckBox::RefValue

Included Services - Summary
::com::sun::star::form::component::DatabaseCheckBox
(referenced entity's summary:)
This service specifies a check box which is data-aware, and can be bound to a database field.
BindableDataAwareControlModel

specifies the interaction between an internal binding to a database column, and an external value binding.

Properties' Summary
string
SecondaryRefValue
specifies a value which is to be associated with the control when it's not checked.  
Included Services - Details
::com::sun::star::form::component::DatabaseCheckBox
(referenced entity's summary:)
This service specifies a check box which is data-aware, and can be bound to a database field.
BindableDataAwareControlModel
Description
specifies the interaction between an internal binding to a database column, and an external value binding.

Properties' Details
SecondaryRefValue
string SecondaryRefValue;
Description
specifies a value which is to be associated with the control when it's not checked.

::com::sun::star::form::component::CheckBox::RefValue is transferred to possible external value bindings as soon as the check box is checked. With the member SecondaryRefValue, clients of the check box can also associate a value with the not checked state of the control.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.