LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Included Services | Public Attributes | List of all members
DatabaseFormattedField Service Referencepublished

This service specifies a formatted field model which is data-aware, and can be bound to a database field. More...

import "DatabaseFormattedField.idl";

Inheritance diagram for DatabaseFormattedField:
FormattedField DataAwareControlModel UnoControlFormattedFieldModel FormControlModel XReset FormControlModel XBoundComponent XLoadListener XReset XInterface XEventListener XUpdateBroadcaster XPropertyState XFastPropertySet FormComponent UnoControlModel XInterface XPropertyState XFastPropertySet FormComponent UnoControlModel UnoControlModel BindableDatabaseFormattedField

Included Services

service com::sun::star::form::component::FormattedField
 
service com::sun::star::form::DataAwareControlModel
 
- Included Services inherited from FormattedField
service com::sun::star::awt::UnoControlFormattedFieldModel
 
service com::sun::star::form::FormControlModel
 
- Included Services inherited from UnoControlFormattedFieldModel
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

boolean ConvertEmptyToNull
 determines if an empty text should be treated as a NULL value. 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...
 
- 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 UnoControlModel
string DefaultControl
 specifies the service name of the default control for this model. More...
 
- Public Attributes inherited from FormComponent
string Name
 the name of the component. More...
 

Additional Inherited Members

- Exported Interfaces inherited from FormattedField
interface com::sun::star::form::XReset
 can be used to reset the control to it's default state. More...
 
- 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...
 
- 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 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...
 

Detailed Description

This service specifies a formatted field model which is data-aware, and can be bound to a database field.

Exported Interfaces

Member Data Documentation

boolean ConvertEmptyToNull
property

determines if an empty text should be treated as a NULL value.

When the user enters text into a formatted field control, and after this, the control content is to be committed into the database field the control is bound to, a decision must be made how to deal with empty strings.
This is controlled by ConvertEmptyToNull.

If the property is set to TRUE, and an empty text is to be committed, this is converted into NULL, else it is written as empty string.


The documentation for this service was generated from the following file: