(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

unpublished interface XSubDocument
Usage Restrictions
not published
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 @raises ::com::sun::star::lang::WrappedTargetException if an error occurs during storing the document  
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. @raises ::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. @raises ::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 @raises ::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. @raises ::com::sun::star::lang::WrappedTargetException if an error occurs during closing the document
Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.