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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.