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 DocumentDefinition
Usage Restrictions
not published
Description
specifies a sub document of a OfficeDatabaseDocument.

Usual instances of a DocumentDefinition are forms and reports.

Note that the DocumentDefinition does not denote the actual document (i.e. an object supporting the ::com::sun::star::frame::XModel interface), but only a shortcut to access and load those actual documents.


Included Services - Summary
DefinitionContent

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

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
XSubDocument
(referenced entity's summary:)
allows operating on a sub document of an OfficeDatabaseDocument
Properties' Summary
[ readonly ] string
Name
is the name of the document. If the document is part of the container, it is not possible to alter the name. 
[ readonly ] boolean
AsTemplate
Indicates if the document is to be used as template, for example, if a report is to be filled with data.  
Included Services - Details
DefinitionContent
Description
provides functionality for treating the object 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: loads the sub document in an own frame. The return value of the execute method is the model of the loaded document.
  • store: stores the document.
  • openDesign: opens the sub document in an own frame, in design mode. The user can make changes to the document, and save those changes. The return value of the execute method is the model of the loaded document.
  • preview: retrieves an image showing a preview of the sub document.
  • getDocumentInfo: retrieves the document information, as ::com::sun::star::document::XDocumentInfo instance, of the sub document.
  • delete: deletes the sub document from the database document.
  • close: closes the sub document, if it had previously been opened using either the open or openDesign command. The return value of the execute command is a boolean value indicating whether the sub document could be closed. Reasons for not closing the document include vetos by third parties, for instance, because the user opened a dialog modal to the sub document, or a long-running task such as printing is currently running.
  • show: shows the sub document. This is useful if you previously opened the document hidden, or if you previously hide it using the hide command.
    The open command is not available if the sub document has not been loaded, yet.
  • hide: hides the sub document. In opposite to the close command, only the document window is hidden, but the document is kept loaded. A subsequent execution of the show command will show the window, again.
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
XSubDocument
(referenced entity's summary:)
allows operating on a sub document of an OfficeDatabaseDocument
Properties' Details
Name
[ readonly ] string Name;
Description
is the name of the document. If the document is part of the container, it is not possible to alter the name.
AsTemplate
[ readonly ] boolean AsTemplate;
Description
Indicates if the document is to be used as template, for example, if a report is to be filled with data.

 
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.