<html> <head> <title>Service DocumentDefinition</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="DocumentDefinition-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"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></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"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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 DocumentDefinition</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>specifies a sub document of a <a href="OfficeDatabaseDocument.html">OfficeDatabaseDocument</a>. </dd> <dd><p>Usual instances of a <code>DocumentDefinition</code> are forms and reports.</p> <p>Note that the <code>DocumentDefinition</code> does not denote the actual document (i.e. an object supporting the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a> interface), but only a shortcut to access and load those actual documents.</p> </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="DefinitionContent.html">DefinitionContent</a></td> <td class="imsum_right"><p>provides functionality for treating the object 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="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>provides information about and access to the properties from an implementation. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XSubDocument.html">XSubDocument</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>allows operating on a sub document of an <a href="OfficeDatabaseDocument.html">OfficeDatabaseDocument</a> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#Name">Name</a></td> <td class="imsum_right">is the name of the document. If the document is part of the container, it is not possible to alter the name. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#AsTemplate">AsTemplate</a></td> <td class="imsum_right">Indicates if the document is to be used as template, for example, if a report is to be filled with data. </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="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 object 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>: loads the sub document in an own frame. The return value of the <code>execute</code> method is the model of the loaded document.</li> <li><strong>store</strong>: stores the document.</li> <li><strong>openDesign</strong>: 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 <code>execute</code> method is the model of the loaded document.</li> <li><strong>preview</strong>: retrieves an image showing a preview of the sub document.</li> <li><strong>getDocumentInfo</strong>: retrieves the document information, as ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XDocumentInfo.html">XDocumentInfo</a> instance, of the sub document.</li> <li><strong>delete</strong>: deletes the sub document from the database document.</li> <li><strong>close</strong>: closes the sub document, if it had previously been opened using either the <code>open</code> or <code>openDesign</code> command. The return value of the <code>execute</code> command is a <code>boolean</code> 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.</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="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</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>provides information about and access to the properties from an implementation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XSubDocument" class="membertitle"><a href="XSubDocument.html">XSubDocument</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>allows operating on a sub document of an <a href="OfficeDatabaseDocument.html">OfficeDatabaseDocument</a> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>Name</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the name of the document. If the document is part of the container, it is not possible to alter the name.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AsTemplate" class="membertitle">AsTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>AsTemplate</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Indicates if the document is to be used as template, for example, if a report is to be filled with data. </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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5202
