Interface XDatabaseDocumentUI

Devguide

Index

Methods' Summary

Methods' Details

Attributes' Summary

Attributes' Details

:: com :: sun :: star :: sdb :: application ::

unpublished

interface XDatabaseDocumentUI

Description: provides access to the user interface of a database document; This interface is available when a database document has been loaded into a frame, at the controller of this frame.
Since: OOo 2.2.0
See also: ::com::sun::star::frame::Controller, ::com::sun::star::sdb::DatabaseDocument

Methods' Summary
isConnected	determines whether the application is currently connected to the database
connect	lets the application connect to the database

Methods' Details

isConnected

boolean
isConnected();

Description: determines whether the application is currently connected to the database

connect

boolean
connect();

Description

lets the application connect to the database

If the application is already connected, nothing happens. If it is not connected, the application will try to establish a connection by using ::com::sun::star::sdbc::XDataSource::getConnection with the current settings, as specified in the ::com::sun::star::sdb::DataSource::Settings member.

If the connection cannot be established, the respective error message is shown in the application window.

Returns

whether or not the connection attempt was successful, i.e. whether or not a subsequent call to isConnected would return true.

Attributes' Summary
DataSource	provides access to the data source belong to the database document
ApplicationMainWindow	provides access to the applicatio's main window
ActiveConnection	provides access to the current connection of the application

Attributes' Details

DataSource

[ readonly ] ::com::sun::star::sdbc::XDataSource DataSource; Description provides access to the data source belong to the database document

ApplicationMainWindow

[ readonly ] ::com::sun::star::awt::XWindow ApplicationMainWindow; Description provides access to the applicatio's main window Note that reading this atttribute is equivalent to querying the component for the ::com::sun::star::frame::XController interface, asking the controller for its frame, and asking this frame for its container window. See also ::com::sun::star::frame::XController, ::com::sun::star::frame::XFrame

ActiveConnection

[ readonly ] ::com::sun::star::sdbc::XConnection ActiveConnection; Description provides access to the current connection of the application Note that the connection returned here is really the working connection of the application. Clients should not misuse it, in particular, closing the connection can yield unexpected results and should definately be avoided.

Top of Page