Service OfficeDatabaseDocument

Exported Interfaces - Summary
XOfficeDatabaseDocument	(referenced entity's summary:) simplifies the accessing of data sources, and it's corresponding database document and forms, and reports.
::com::sun::star::document::XEmbeddedScripts	allows access to the Basic macros and dialogs possibly embedded in the document (details)
::com::sun::star::script::provider::XScriptProviderSupplier	supplies a script provider which can be used to execute macros and scripts embedded in the document (details)
::com::sun::star::frame::XLoadable	allows to initialize the the document, either from scratch, or from a stored database document. (details)
::com::sun::star::document::XDocumentEventBroadcaster	allows to register for notifications happening in the document (details)
::com::sun::star::util::XCloseable	implements life time control (details)

Included Services - Details

::com::sun::star::document::OfficeDocument

Description specifies basic functionality of a document in OpenOffice.org Note that a database document actually does not support the ::com::sun::star::view::XPrintable interface. The non-optional requirement of this interface in the ::com::sun::star::document::OfficeDocument service is considered a documentation error.

Exported Interfaces - Details

XOfficeDatabaseDocument

(referenced entity's summary:) simplifies the accessing of data sources, and it's corresponding database document and forms, and reports.

::com::sun::star::document::XEmbeddedScripts

Description allows access to the Basic macros and dialogs possibly embedded in the document Since OOo 3.1

::com::sun::star::script::provider::XScriptProviderSupplier

Description supplies a script provider which can be used to execute macros and scripts embedded in the document Since OOo 3.1

::com::sun::star::frame::XLoadable

Description allows to initialize the the document, either from scratch, or from a stored database document. A newly instantiated database document cannot be operated until it is fully initialized. There are three possible means to do this initialization: calling `XLoadable::initNew` calling `XLoadable::load` calling `XStorable::storeAsURL` The third option was added for compatibility reasons, since a DatabaseDocument in earlier versions of OpenOffice.org did not support the `XLoadable` interface, so the usual way of creating a document from scratch was to create it, set properties as needed, and store it. Since OOo 3.1

::com::sun::star::document::XDocumentEventBroadcaster

Description

allows to register for notifications happening in the document

The following events are broadcasted by a database document

Event Name	broadcasted when	broadcasted synchronously
OnCreate	the document has been newly created. This does not imply that the document has been loaded into a frame, it just means the initialization has been finished.	yes
OnLoadFinished	the document has been completely loaded. This does not imply that the document has been loaded into a frame, it just means the load process has been finished.	yes
OnNew	the document has been initialized from scratch, including plugging it into a frame.	no
OnLoad	the document has been completely loaded, including plugging it into a frame.	no
OnSave	the document is about to be saved.	yes
OnSaveDone	saving the document succeeeded.	no
OnSaveFailed	saving the document failed.	no
OnSaveAs	the document is about to be saved under a new name.	yes
OnSaveAsDone	saving the document under a new name succeeeded.	no
OnSaveAsFailed	saving the document under a new name failed.	no
OnSaveTo	the document is about to be saved to a location different from its current location, but without adjusting the current location.	yes
OnSaveToDone	saving the document to a different location succeeeded.	no
OnSaveToFailed	saving the document to a different location failed.	no
OnPrepareUnload	the document is about to be closed.	yes
OnUnload	the document is being closed.	yes
OnFocus	a view to the document obtained the focus.	no
OnUnfocus	a view to the document lost the focus.	no
OnModifyChanged	the modified state of the document changed.	no
OnViewCreated	a view to the document has been created, and attached to the document.	no
OnPrepareViewClosing	a view to the document is about to be closed.	yes
OnViewClosed	a view to the document has been closed.	no
OnTitleChanged	the title of the document changed.	no
OnSubComponentOpened	From with a view to the document, a view to a sub component (e.g. a table or a report) has been opened.	no
OnSubComponentClosed	From with a view to the document, a view to a sub component (e.g. a table or a report) has been closed.	no

Since

OOo 3.1

::com::sun::star::util::XCloseable

Description implements life time control Whoever retrieves a OfficeDatabaseDocument should be aware of life time issues, since a document needs to be closed when nobody needs it anymore. This implies that clients of a document need to ensure that as soon as they don't need, they invoke ::com::sun::star::util::XCloseable::close. Since this can be done by multiple clients, every client is additionally required to register itself as ::com::sun::star::util::XCloseListener at the document, to prevent some other client closing the model while it's still needed by the first client.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous