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 ::

interface XSubDocument
Description
allows operating on a sub document of an OfficeDatabaseDocument
Since
OOo 3.1

Methods' Summary
open opens the sub document  
openDesign opens the sub document in design mode  
store stores the sub document, if it had previously been opened in either mode  
close closes the sub document, if it had previously been opened in either mode  
Methods' Details
open
::com::sun::star::lang::XComponent
open()
raises( ::com::sun::star::lang::WrappedTargetException );

Description
opens the sub document

Note that opening the document means it is displayed in an own top-level frame on the desktop.

Returns
the sub document, usually an ::com::sun::star::frame::XModel, or an ::com::sun::star::frame::XController if the sub document does not have an own model.
Throws
::com::sun::star::lang::WrappedTargetException if an error occurs during opening the document
openDesign
::com::sun::star::lang::XComponent
openDesign()
raises( ::com::sun::star::lang::WrappedTargetException );

Description
opens the sub document in design mode
Returns
the sub document, usually an ::com::sun::star::frame::XModel, or an ::com::sun::star::frame::XController if the sub document does not have an own model.
Throws
::com::sun::star::lang::WrappedTargetException if an error occurs during opening the document
store
void
store()
raises( ::com::sun::star::lang::WrappedTargetException );

Description
stores the sub document, if it had previously been opened in either mode
Throws
::com::sun::star::lang::WrappedTargetException if an error occurs during storing the document
close
boolean
close()
raises( ::com::sun::star::lang::WrappedTargetException );

Description
closes the sub document, if it had previously been opened in either mode
Returns
true if and only if the document could be closed, false otherwise, e.g. if the closing has been vetoed by the user.
Throws
::com::sun::star::lang::WrappedTargetException if an error occurs during closing the document
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.