Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service DocumentContainer
Usage Restrictions
not published
Description
describes a container which provides access to documents embedded into a database document, usually forms and reports.

The ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() should be used to create sub document container or form, or report objects.

The embedded documents do not support any particular database related service, instead, they're usual ::com::sun::star::document::OfficeDocuments.
The only thing worth mentioning here is that they support the ::com::sun::star::container::XChild interface, whose ::com::sun::star::container::XChild::getParent method can be used to obtain the database document which the embedded document belongs to.

See also
DocumentDefinition, OfficeDatabaseDocument

Included Services - Summary
DefinitionContainer
(referenced entity's summary:)
describes a container which provides access to database related definitions like commands, forms, and reports.
DefinitionContent

provides functionality for treating the container as part of a hierarchy of a database document's sub documents. (details)

Exported Interfaces - Summary
::com::sun::star::frame::XComponentLoader

can be used to load the document inside. (details)

::com::sun::star::lang::XMultiServiceFactory

can be used to create container elements. (details)

::com::sun::star::container::XHierarchicalNameContainer

can be used to create folder hierarchies and to organize forms or reports in different sub folders.

Included Services - Details
DefinitionContainer
(referenced entity's summary:)
describes a container which provides access to database related definitions like commands, forms, and reports.
DefinitionContent
Description
provides functionality for treating the container as part of a hierarchy of a database document's sub documents.

The ::com::sun::star::ucb::XCommandProcessor::execute method of a DocumentDefinition supports at least the following commands, additionally to the ones already supported by the DefinitionContent:

  • open: provides a ::com::sun::star::ucb::XDynamicResultSet to enumerate the content of the document container.
  • delete: deletes the document container, including all contained documents.
Exported Interfaces - Details
::com::sun::star::frame::XComponentLoader
Description
can be used to load the document inside.

URL: describes the name of the document definition to load, TargetFrameName: isn't used. SearchFlags: isn't used. Arguments:

  1. PropertyValue
  2. Name = ActiveConnection Value = The connection which should be used when opening the text document.
  3. PropertyValue
  4. Name = OpenMode Value = string, "open" if the document should be opened in live mode (editing is not possible), "openDesign" if the document should be open in design mode (editing is possible)
See also
::com::sun::star::sdbc::XConnection

::com::sun::star::lang::XMultiServiceFactory
Description
can be used to create container elements.

If this interface is supported, the object created using it (e.g., the object returned by XMultiServiceFactory::createInstanceWithArguments() ) can be used as container elements.

::com::sun::star::container::XHierarchicalNameContainer
Description
can be used to create folder hierarchies and to organize forms or reports in different sub folders.

 
Top of Page

Apache Software Foundation

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

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