Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

interface XFilter
Description
interface to filter documents

This interface will be used by service ImportFilter or ExportFilter to support loading/saving of documents in different formats. The target/source of such filter operations must be known before filtering will be started. (see XImporter and XExporter too) Otherwise this interface can't work right.

See also
ImportFilter, ExportFilter, XImporter, XExporter
Developers Guide
OfficeDev - XML Based Filter Development - Introduction

Methods' Summary
filter filter the document.  
cancel cancel the process.  
Methods' Details
filter
boolean
filter( [in] sequence< ::com::sun::star::beans::PropertyValue >  aDescriptor );

Description
filter the document.

The given MediaDescriptor holds all neccessary information about the document. Don't hold hard references to the descriptor items. You must copy needed information! Otherwise we couldn't destroy (for example) an existing input stream!

Parameter aDescriptor
the MediaDescriptor describing the respective document.
Returns
a boolean value indicating whether the filter operation was successful or not.
cancel
void
cancel();

Description
cancel the process.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.