<html> <head> <title>Service OfficeDocument</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="OfficeDocument-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">Included Services</td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</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">document</a> :: </p> </td> </tr> <tr> <td class="title">service OfficeDocument</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>abstract service which specifies a storable and printable document </dd> <dd><p> All major document-like components should support this service instead of simple components which supports a ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Controller.html">Controller</a> or pure ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> only. </p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Controller.html">Controller</a></dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>represents a component which is created from an URL and arguments </dd> <dd><p> It is a representation of a resource in the sense that it was created/loaded from the resource. The arguments are passed to the loader to modify its behavior. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifiable.html">XModifiable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>a storable document should provide information about his modify state </dd> <dd><p> With this interface it's possible too, to reset the modify state. That can be neccessary to prevent code against problem during closing of the document without saving any changes. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XStorable.html">XStorable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>offers a simple way to store a component to an URL </dd> <dd><p> This interface supports functionality <ul> <li>to make a copy of current component by saving it to another location</li> <li>to commit made changes</li> <li>to convert it by saving it by using suitable filter name.</li> </ul> </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../view/module-ix.html">view</a>::<a href="../view/XPrintable.html">XPrintable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>offers a way to print a component </dd> <dd><p> It's possible to specify wich printer should be used and of course print the document on it. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XEventBroadcaster.html">XEventBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>makes it possible to register listeners which are called whenever a document event occurs </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XEventsSupplier.html">XEventsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>access to bound event handlers </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentInfoSupplier.html">XDocumentInfoSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>document can provide a <a href="DocumentInfo.html">DocumentInfo</a> </dd> <dd><p> Instead of the <a href="StandaloneDocumentInfo.html">StandaloneDocumentInfo</a> service the <a href="DocumentInfo.html">DocumentInfo</a> will be available on an already opened document only. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XViewDataSupplier.html">XViewDataSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>access to some properties describing all open views to a document </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../view/module-ix.html">view</a>::<a href="../view/XPrintJobBroadcaster.html">XPrintJobBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows for getting information about a print job </dd> <dt><b/></dt> <dd/></dl> </td> </tr> <tr> <td class="imsum_left"><a href="XEmbeddedScripts.html">XEmbeddedScripts</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is supported when the document can contain scripts and dialogs </dd> <dt><b/></dt> <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">boolean<br> <a href="#AutomaticControlFocus">AutomaticControlFocus</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls the focus behaviour of the form controls in the document </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ApplyFormDesignMode">ApplyFormDesignMode</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls the initial (on-load) behavior of the form controls in the document </td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#RuntimeUID">RuntimeUID</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains a unique id for the document </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="AutomaticControlFocus" class="membertitle">AutomaticControlFocus</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AutomaticControlFocus</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls the focus behaviour of the form controls in the document </dd> <dd><p> If this flag is set to <b>true</b>, any view belonging to the document should focus the first control in the document. With this, you may control if your document works primarily as a form document. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ApplyFormDesignMode" class="membertitle">ApplyFormDesignMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ApplyFormDesignMode</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls the initial (on-load) behavior of the form controls in the document </dd> <dd><p>If set to <b>true</b>, upon loading the document, the form controls will be in design mode.<br/> If set to <b>false</b>, they will be alive, i.e. operational.<br/> With this, you may control if your document works primarily as a form document. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RuntimeUID" class="membertitle">RuntimeUID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>RuntimeUID</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains a unique id for the document </dd> <dd><p>Once calculated, the id must not change until the document has been closed. Upon closing it will not be made persistent. Thus, the document may get a different id every time it gets loaded.</p> </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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>