LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
FormOperations Service Reference

encapsulates operations on a database form which has a UI representation, and is interacting with the user. More...

import"FormOperations.idl";

Inheritance diagram for FormOperations:
XFormOperations XComponent XInterface

Public Member Functions

 createWithFormController ([in] XFormController Controller) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a FormOperations instance which works on a com::sun::star::form::FormController instance. More...
 
 createWithForm ([in] XForm Form) raises ( ::com::sun::star::lang::IllegalArgumentException )
 creates a FormOperations instance which works on a com::sun::star::form::component::DataForm instance. More...
 
- Public Member Functions inherited from XFormOperations
FeatureState getState ([in] short Feature)
 retrieves the current state of the given feature More...
 
boolean isEnabled ([in] short Feature)
 determines whether a feature is currently enabled. More...
 
void execute ([in] short Feature) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::sdbc::SQLException , ::com::sun::star::lang::WrappedTargetException )
 executes the operation associated with the given feature More...
 
void executeWithArguments ([in] short Feature, [in] sequence< ::com::sun::star::beans::NamedValue > Arguments) raises ( ::com::sun::star::lang::IllegalArgumentException , ::com::sun::star::sdbc::SQLException , ::com::sun::star::lang::WrappedTargetException )
 executes the operation associated with the given feature, with passing arguments for execution More...
 
boolean commitCurrentRecord ([out] boolean RecordInserted) raises ( ::com::sun::star::sdbc::SQLException )
 commits the current record of the form More...
 
boolean commitCurrentControl () raises ( ::com::sun::star::sdbc::SQLException )
 commits the current control of our controller More...
 
boolean isInsertionRow () raises ( ::com::sun::star::lang::WrappedTargetException )
 determines whether the form is currently positioned on the insertion row More...
 
boolean isModifiedRow () raises ( ::com::sun::star::lang::WrappedTargetException )
 determines whether the current row of the form is modified 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 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...
 

Additional Inherited Members

- Public Attributes inherited from XFormOperations
::com::sun::star::sdbc::XRowSet Cursor
 provides access to the cursor of the form the instance is operating on. More...
 
::com::sun::star::sdbc::XResultSetUpdate UpdateCursor
 provides access to the update cursor of the form the instance is operating on. More...
 
::com::sun::star::form::runtime::XFormController Controller
 provides access to the form controller which the instance is operating on. More...
 
XFeatureInvalidation FeatureInvalidation
 denotes the instance which should be notified about features whose state might have changed. More...
 

Detailed Description

encapsulates operations on a database form which has a UI representation, and is interacting with the user.

Since
OOo 2.2

Member Function Documentation

createWithForm ( [in] XForm  Form)
raises ( ::com::sun::star::lang::IllegalArgumentException
)

creates a FormOperations instance which works on a com::sun::star::form::component::DataForm instance.

Exceptions
IllegalArgumentExceptionif the given form is NULL, or does not support the com::sun::star::form::component::DataForm service.
createWithFormController ( [in] XFormController  Controller)
raises ( ::com::sun::star::lang::IllegalArgumentException
)

creates a FormOperations instance which works on a com::sun::star::form::FormController instance.

Exceptions
IllegalArgumentExceptionif the given form controller is NULL, or does not have a model denoting a valid com::sun::star::form::component::DataForm instance.

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