<html> <head> <title>Service DocumentContainer</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="DocumentContainer-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdb</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service DocumentContainer</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>describes a container which provides access to documents embedded into a database document, usually forms and reports. </dd> <dd><p>The ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a>::<a href="../lang/XMultiServiceFactory.html#createInstanceWithArguments">createInstanceWithArguments()</a> should be used to create sub document container or form, or report objects.</p> <p>The embedded documents do not support any particular database related service, instead, they're usual ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/OfficeDocument.html">OfficeDocument</a>s.<br/> The only thing worth mentioning here is that they support the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a> interface, whose ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a>::<a href="../container/XChild.html#getParent">getParent</a> method can be used to obtain the database document which the embedded document belongs to. </p> </dd> <dt><b>See also</b></dt> <dd><a href="DocumentDefinition.html">DocumentDefinition</a>, <a href="OfficeDatabaseDocument.html">OfficeDatabaseDocument</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left"><a href="DefinitionContainer.html">DefinitionContainer</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>describes a container which provides access to database related definitions like commands, forms, and reports. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="DefinitionContent.html">DefinitionContent</a></td> <td class="imsum_right"><p>provides functionality for treating the container as part of a hierarchy of a database document's sub documents. (<a href="#DefinitionContent">details</a>)</p> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XComponentLoader.html">XComponentLoader</a></td> <td class="imsum_right"><p>can be used to load the document inside. (<a href="#XComponentLoader">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a></td> <td class="imsum_right"><p>can be used to create container elements. (<a href="#XMultiServiceFactory">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameContainer.html">XHierarchicalNameContainer</a></td> <td class="imsum_right"><p>can be used to create folder hierarchies and to organize forms or reports in different sub folders. </p> </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="DefinitionContainer" class="membertitle"><a href="DefinitionContainer.html">DefinitionContainer</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>describes a container which provides access to database related definitions like commands, forms, and reports. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="DefinitionContent" class="membertitle"><a href="DefinitionContent.html">DefinitionContent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides functionality for treating the container as part of a hierarchy of a database document's sub documents. </dd> <dd><p>The ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandProcessor.html">XCommandProcessor</a>::<a href="../ucb/XCommandProcessor.html#execute">execute</a> method of a <code>DocumentDefinition</code> supports at least the following commands, additionally to the ones already supported by the DefinitionContent: <ul> <li><strong>open</strong>: provides a ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XDynamicResultSet.html">XDynamicResultSet</a> to enumerate the content of the document container.</li> <li><strong>delete</strong>: deletes the document container, including all contained documents.</li> </ul> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XComponentLoader" class="membertitle">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XComponentLoader.html">XComponentLoader</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>can be used to load the document inside. </dd> <dd><p> URL: describes the name of the document definition to load, TargetFrameName: isn't used. SearchFlags: isn't used. Arguments: <ol> <li>PropertyValue</li> Name = ActiveConnection Value = The connection which should be used when opening the text document. <li>PropertyValue</li> 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) </ol> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a><br> </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XMultiServiceFactory" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>can be used to create container elements. </dd> <dd><p> If this interface is supported, the object created using it (e.g., the object returned by <method scope="com.sun.star.lang">XMultiServiceFactory::createInstanceWithArguments()</method> ) can be used as container elements. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XHierarchicalNameContainer" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XHierarchicalNameContainer.html">XHierarchicalNameContainer</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>can be used to create folder hierarchies and to organize forms or reports in different sub folders. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, 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.</p> </div> <!-- id="adc-idlref" --> </body> </html>