(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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

Copyright © 1995, 2010, 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.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.