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 necessary 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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.