<html> <head> <title>Module document</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="navimainself">Module</td> <td class="navimainnone">Use</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">Nested Modules</td> <td class="navisub"><a href="#Services" class="navisub">Services</a></td> <td class="navisub">Singletons</td> <td class="navisub"><a href="#Interfaces" class="navisub">Interfaces</a></td> <td class="navisub"><a href="#Structs" class="navisub">Structs</a></td> <td class="navisub"><a href="#Exceptions" class="navisub">Exceptions</a></td> <td class="navisub">Enums</td> <td class="navisub">Typedefs</td> <td class="navisub"><a href="#ConstantGroups" class="navisub">Constant Groups</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> :: </p> </td> </tr> <tr> <td class="title">module document</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Office document related interfaces.</dd> </dl> </td> </tr> </table> <hr> <a name="Services"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Services</td> </tr> <tr> <td class="imsum_left"><a href="DocumentInfo.html">DocumentInfo</a></td> <td class="imsum_right">[ DEPRECATED ]<br> this service provides document-specific information like the author, creation date and user fields </td> </tr> <tr> <td class="imsum_left"><a href="DocumentProperties.html">DocumentProperties</a></td> <td class="imsum_right">provides document-specific information such as the author, creation date, and user-defined fields. </td> </tr> <tr> <td class="imsum_left"><a href="DocumentRevisionListPersistence.html">DocumentRevisionListPersistence</a></td> <td class="imsum_right">interface to maintain a list of document revisions </td> </tr> <tr> <td class="imsum_left"><a href="EventDescriptor.html">EventDescriptor</a></td> <td class="imsum_right">specifies an event binding for a document or a document content </td> </tr> <tr> <td class="imsum_left"><a href="Events.html">Events</a></td> <td class="imsum_right">is a collection of all events supported by a document or content of a document </td> </tr> <tr> <td class="imsum_left"><a href="ExportFilter.html">ExportFilter</a></td> <td class="imsum_right">filter for exports </td> </tr> <tr> <td class="imsum_left"><a href="ExtendedTypeDetection.html">ExtendedTypeDetection</a></td> <td class="imsum_right">describes a class of service which will be used for deep <a href="TypeDetection.html">TypeDetection</a> in a generic way </td> </tr> <tr> <td class="imsum_left"><a href="ExtendedTypeDetectionFactory.html">ExtendedTypeDetectionFactory</a></td> <td class="imsum_right">factory to create extended type detection components. </td> </tr> <tr> <td class="imsum_left"><a href="FilterAdapter.html">FilterAdapter</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="FilterFactory.html">FilterFactory</a></td> <td class="imsum_right">factory to create filter components. </td> </tr> <tr> <td class="imsum_left"><a href="HeaderFooterSettings.html">HeaderFooterSettings</a></td> <td class="imsum_right">describes properties that control the formatting of headers and footers for documents that do not allow individual settings for individual parts like pages or slides. </td> </tr> <tr> <td class="imsum_left"><a href="ImportFilter.html">ImportFilter</a></td> <td class="imsum_right">filter for imports </td> </tr> <tr> <td class="imsum_left"><a href="LinkTarget.html">LinkTarget</a></td> <td class="imsum_right">This service is implemented by objects inside a document object model that can be the target of a link inside a document </td> </tr> <tr> <td class="imsum_left"><a href="LinkTargets.html">LinkTargets</a></td> <td class="imsum_right">This service gives access to a collection of names that are child links of the parent object that supplied this service. </td> </tr> <tr> <td class="imsum_left"><a href="MediaDescriptor.html">MediaDescriptor</a></td> <td class="imsum_right">describes properties of a document, regarding the relationship between the loaded document and the resource the document is loaded from / stored to. </td> </tr> <tr> <td class="imsum_left"><a href="OOXMLDocumentPropertiesImporter.html">OOXMLDocumentPropertiesImporter</a></td> <td class="imsum_right">allows to import document properties from OOXML format </td> </tr> <tr> <td class="imsum_left"><a href="OfficeDocument.html">OfficeDocument</a></td> <td class="imsum_right">abstract service which specifies a storable and printable document </td> </tr> <tr> <td class="imsum_left"><a href="OleEmbeddedServerRegistration.html">OleEmbeddedServerRegistration</a></td> <td class="imsum_right">registers embedded server for StarOffice documents </td> </tr> <tr> <td class="imsum_left"><a href="PDFDialog.html">PDFDialog</a></td> <td class="imsum_right">This service is for a PDFDialog </td> </tr> <tr> <td class="imsum_left"><a href="Settings.html">Settings</a></td> <td class="imsum_right">describes properties that apply to the whole document of any application. </td> </tr> <tr> <td class="imsum_left"><a href="StandaloneDocumentInfo.html">StandaloneDocumentInfo</a></td> <td class="imsum_right">[ DEPRECATED ]<br> extends the service <a href="DocumentInfo.html">DocumentInfo</a> to have access on such document properties without loading the whole document </td> </tr> <tr> <td class="imsum_left"><a href="TypeDetection.html">TypeDetection</a></td> <td class="imsum_right">capsulate a type detection service and provide read/write access on it's configuration data. </td> </tr> <tr> <td class="imsum_left"><a href="VbaEventsHelper.html">VbaEventsHelper</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XMLBasicExporter.html">XMLBasicExporter</a></td> <td class="imsum_right">Filter for exporting Basic macros to the OpenOffice.org file format. </td> </tr> <tr> <td class="imsum_left"><a href="XMLBasicImporter.html">XMLBasicImporter</a></td> <td class="imsum_right">Filter for importing Basic macros from the OpenOffice.org file format. </td> </tr> <tr> <td class="imsum_left"><a href="XMLOasisBasicExporter.html">XMLOasisBasicExporter</a></td> <td class="imsum_right">Filter for exporting Basic macros to the OASIS Open Office file format. </td> </tr> <tr> <td class="imsum_left"><a href="XMLOasisBasicImporter.html">XMLOasisBasicImporter</a></td> <td class="imsum_right">Filter for importing Basic macros from the OASIS Open Office file format. </td> </tr> </table> <a name="Interfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Interfaces</td> </tr> <tr> <td class="imsum_left"><a href="XActionLockable.html">XActionLockable</a></td> <td class="imsum_right">makes it possible to prevent object internal updates for a certain period to be able to quickly change multiple parts of the objects, where the updates would invalidate each other, anyway. </td> </tr> <tr> <td class="imsum_left"><a href="XBinaryStreamResolver.html">XBinaryStreamResolver</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XCodeNameQuery.html">XCodeNameQuery</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XCompatWriterDocProperties.html">XCompatWriterDocProperties</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XDocumentEventBroadcaster.html">XDocumentEventBroadcaster</a></td> <td class="imsum_right">allows to be notified of events happening in an <a href="OfficeDocument.html">OfficeDocument</a>, and to cause notification of such events. </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentEventCompatibleHelper.html">XDocumentEventCompatibleHelper</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XDocumentEventListener.html">XDocumentEventListener</a></td> <td class="imsum_right">allows to be notified of events happening in an <a href="OfficeDocument.html">OfficeDocument</a> </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentInfo.html">XDocumentInfo</a></td> <td class="imsum_right">[ DEPRECATED ]<br> provides access to the user fields for the information regarding the document </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentInfoSupplier.html">XDocumentInfoSupplier</a></td> <td class="imsum_right">[ DEPRECATED ]<br> through this interface documents can provide a <a href="DocumentInfo.html">DocumentInfo</a> </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentInsertable.html">XDocumentInsertable</a></td> <td class="imsum_right">makes it possible to import a document from a given URL into this document. </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentLanguages.html">XDocumentLanguages</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XDocumentProperties.html">XDocumentProperties</a></td> <td class="imsum_right">provides document-specific information such as the author, creation date, and user-defined fields. </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentPropertiesSupplier.html">XDocumentPropertiesSupplier</a></td> <td class="imsum_right">provides access to the <a href="XDocumentProperties.html">XDocumentProperties</a> instance of a document. </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentRevisionListPersistence.html">XDocumentRevisionListPersistence</a></td> <td class="imsum_right">interface to load or store a list of document revisions from or to a document using the packed XML file format </td> </tr> <tr> <td class="imsum_left"><a href="XDocumentSubStorageSupplier.html">XDocumentSubStorageSupplier</a></td> <td class="imsum_right">through this interface documents can provide access to their substorages </td> </tr> <tr> <td class="imsum_left"><a href="XEmbeddedObjectResolver.html">XEmbeddedObjectResolver</a></td> <td class="imsum_right">this interface converts embedded object URLs from one URL space to another. </td> </tr> <tr> <td class="imsum_left"><a href="XEmbeddedObjectSupplier.html">XEmbeddedObjectSupplier</a></td> <td class="imsum_right">represents something that provides an embedded object. </td> </tr> <tr> <td class="imsum_left"><a href="XEmbeddedObjectSupplier2.html">XEmbeddedObjectSupplier2</a></td> <td class="imsum_right">represents something that provides an embedded object. </td> </tr> <tr> <td class="imsum_left"><a href="XEmbeddedScripts.html">XEmbeddedScripts</a></td> <td class="imsum_right">is suppoerted by <a href="OfficeDocument.html">OfficeDocument</a>s which allow to embed scripts </td> </tr> <tr> <td class="imsum_left"><a href="XEventBroadcaster.html">XEventBroadcaster</a></td> <td class="imsum_right">[ DEPRECATED ]<br> makes it possible to register listeners which are called whenever a document event (see <a href="EventObject.html">EventObject</a>) occurs </td> </tr> <tr> <td class="imsum_left"><a href="XEventListener.html">XEventListener</a></td> <td class="imsum_right">[ DEPRECATED ]<br> makes it possible to register listeners, which are called whenever a document or document content event occurs </td> </tr> <tr> <td class="imsum_left"><a href="XEventsSupplier.html">XEventsSupplier</a></td> <td class="imsum_right">gives access to a list of URLs bound to events of this object </td> </tr> <tr> <td class="imsum_left"><a href="XExporter.html">XExporter</a></td> <td class="imsum_right">makes it possible to connect a document with an <a href="ExportFilter.html">ExportFilter</a> </td> </tr> <tr> <td class="imsum_left"><a href="XExtendedFilterDetection.html">XExtendedFilterDetection</a></td> <td class="imsum_right">provides a "deep" filter detection </td> </tr> <tr> <td class="imsum_left"><a href="XFilter.html">XFilter</a></td> <td class="imsum_right">interface to filter documents </td> </tr> <tr> <td class="imsum_left"><a href="XFilterAdapter.html">XFilterAdapter</a></td> <td class="imsum_right">This is an interface that can be used to link a filter to the FilterAdapter </td> </tr> <tr> <td class="imsum_left"><a href="XGraphicObjectResolver.html">XGraphicObjectResolver</a></td> <td class="imsum_right">this interface converts graphic object URLs from one URL space to another. </td> </tr> <tr> <td class="imsum_left"><a href="XImporter.html">XImporter</a></td> <td class="imsum_right">makes it possible to connect a document with an <a href="ImportFilter.html">ImportFilter</a> </td> </tr> <tr> <td class="imsum_left"><a href="XInteractionFilterOptions.html">XInteractionFilterOptions</a></td> <td class="imsum_right">A continuation to return filter options from interaction helper. </td> </tr> <tr> <td class="imsum_left"><a href="XInteractionFilterSelect.html">XInteractionFilterSelect</a></td> <td class="imsum_right">continuation used by interaction mechanism at filter detection during loading documents </td> </tr> <tr> <td class="imsum_left"><a href="XLinkTargetSupplier.html">XLinkTargetSupplier</a></td> <td class="imsum_right">interface is supplied by objects inside a document object model that have children that can be the target of a link inside a document. </td> </tr> <tr> <td class="imsum_left"><a href="XMimeTypeInfo.html">XMimeTypeInfo</a></td> <td class="imsum_right">provides information regarding which MIME types are supported by a filter. </td> </tr> <tr> <td class="imsum_left"><a href="XOOXMLDocumentPropertiesImporter.html">XOOXMLDocumentPropertiesImporter</a></td> <td class="imsum_right">allows to import the document properties from OOXML fomat </td> </tr> <tr> <td class="imsum_left"><a href="XRedlinesSupplier.html">XRedlinesSupplier</a></td> <td class="imsum_right">provides access to a container of the redline objects of the document. </td> </tr> <tr> <td class="imsum_left"><a href="XScriptInvocationContext.html">XScriptInvocationContext</a></td> <td class="imsum_right">indicates support for executing scripts contained in a, possibly foreign, document. </td> </tr> <tr> <td class="imsum_left"><a href="XStandaloneDocumentInfo.html">XStandaloneDocumentInfo</a></td> <td class="imsum_right">[ DEPRECATED ]<br> makes it possible to load document information from a resource specified by a URL and to store it into a resource also specified by a URL </td> </tr> <tr> <td class="imsum_left"><a href="XStorageBasedDocument.html">XStorageBasedDocument</a></td> <td class="imsum_right">allows to initialize document with a storage, to store document to a storage, and to set document to be based on provided storage. </td> </tr> <tr> <td class="imsum_left"><a href="XStorageChangeListener.html">XStorageChangeListener</a></td> <td class="imsum_right">allows to be notified when a document is switched to a new storage. </td> </tr> <tr> <td class="imsum_left"><a href="XTypeDetection.html">XTypeDetection</a></td> <td class="imsum_right">support "flat" and "deep" type detection of a given document </td> </tr> <tr> <td class="imsum_left"><a href="XVBAImporter.html">XVBAImporter</a></td> <td class="imsum_right">simple VBA import interface </td> </tr> <tr> <td class="imsum_left"><a href="XVbaEventsHelper.html">XVbaEventsHelper</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XVbaMethodParameter.html">XVbaMethodParameter</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XViewDataSupplier.html">XViewDataSupplier</a></td> <td class="imsum_right">gives access to some properties describing all open views to a document </td> </tr> </table> <a name="Structs"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Structs</td> </tr> <tr> <td class="imsum_left"><a href="DocumentEvent.html">DocumentEvent</a></td> <td class="imsum_right">describes an event happening in an <a href="OfficeDocument.html">OfficeDocument</a> </td> </tr> <tr> <td class="imsum_left"><a href="EventObject.html">EventObject</a></td> <td class="imsum_right">[ DEPRECATED ]<br> is thrown on document and document content events </td> </tr> </table> <a name="Exceptions"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exceptions</td> </tr> <tr> <td class="imsum_left"><a href="AmbigousFilterRequest.html">AmbigousFilterRequest</a></td> <td class="imsum_right">should be used for interaction to handle states of ambigous filter detection </td> </tr> <tr> <td class="imsum_left"><a href="BrokenPackageRequest.html">BrokenPackageRequest</a></td> <td class="imsum_right">Is used for interaction handle in case package is broken. </td> </tr> <tr> <td class="imsum_left"><a href="ChangedByOthersRequest.html">ChangedByOthersRequest</a></td> <td class="imsum_right">Is used for interaction handle to query user decision in case the document being saved was already stored by another user during the editing. </td> </tr> <tr> <td class="imsum_left"><a href="CorruptedFilterConfigurationException.html">CorruptedFilterConfigurationException</a></td> <td class="imsum_right">This exception is thrown in case the global filter configuration does not exists or contains corrupted data. </td> </tr> <tr> <td class="imsum_left"><a href="FilterOptionsRequest.html">FilterOptionsRequest</a></td> <td class="imsum_right">Is used for interaction handle to get filter options. </td> </tr> <tr> <td class="imsum_left"><a href="LockFileIgnoreRequest.html">LockFileIgnoreRequest</a></td> <td class="imsum_right">Is used for interaction handle to query user decision regarding storing to a location where no lock file can be created. </td> </tr> <tr> <td class="imsum_left"><a href="LockedDocumentRequest.html">LockedDocumentRequest</a></td> <td class="imsum_right">Is used for interaction handle to query user decision regarding locked document. </td> </tr> <tr> <td class="imsum_left"><a href="LockedOnSavingRequest.html">LockedOnSavingRequest</a></td> <td class="imsum_right">Is used for interaction handle to query user decision regarding locked document on saving. </td> </tr> <tr> <td class="imsum_left"><a href="NoSuchFilterRequest.html">NoSuchFilterRequest</a></td> <td class="imsum_right">should be used for interaction to handle states of unknown filter during detection </td> </tr> <tr> <td class="imsum_left"><a href="OwnLockOnDocumentRequest.html">OwnLockOnDocumentRequest</a></td> <td class="imsum_right">Is used for interaction handle to query user decision regarding locked document. </td> </tr> </table> <a name="ConstantGroups"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constant Groups</td> </tr> <tr> <td class="imsum_left"><a href="LinkUpdateModes.html">LinkUpdateModes</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="MacroExecMode.html">MacroExecMode</a></td> <td class="imsum_right">Specify whether a macro can be executed. </td> </tr> <tr> <td class="imsum_left"><a href="PrinterIndependentLayout.html">PrinterIndependentLayout</a></td> <td class="imsum_right">specifies whether the document printer metric is used. </td> </tr> <tr> <td class="imsum_left"><a href="RedlineDisplayType.html">RedlineDisplayType</a></td> <td class="imsum_right">specifies which changes in a document are displayed. </td> </tr> <tr> <td class="imsum_left"><a href="UpdateDocMode.html">UpdateDocMode</a></td> <td class="imsum_right">Specify the way a document can be updated. </td> </tr> <tr> <td class="imsum_left"><a href="VbaEventId.html">VbaEventId</a></td> <td class="imsum_right"/></tr> </table> <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>