Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: ui :: dialogs ::

service FilterOptionsDialog
Description
This service enables a filter developer to register a dialog to query for user options before the filter operation is performed.

The user options are stored inside the ::com::sun::star::document::MediaDescriptor and can be queried from the ::com::sun::star::document::MediaDescriptor by the component that implements ::com::sun::star::document::XFilter.

The application will set the ::com::sun::star::document::MediaDescriptor using the interface ::com::sun::star::beans::XPropertyAccess and then call XExecutableDialog::execute.

If that method returns ExecutableDialogResults::OK, the application will retrieve the changed ::com::sun::star::document::MediaDescriptor back using the interface ::com::sun::star::beans::XPropertyAccess. The filter operation is than continued, using the new ::com::sun::star::document::MediaDescriptor.

Otherwise, the filter operation is canceled.

Since
OOo 1.1.2

Exported Interfaces - Summary
::com::sun::star::beans::XPropertyAccess

this interface is used to set the property values of the ::com::sun::star::document::MediaDescriptor before executing the dialog and to retrieve the changed ::com::sun::star::document::MediaDescriptor afterwards.

XExecutableDialog

this interface executes a dialog that displays the options for a filter. If XExecutableDialog::execute returns ExecutableDialogResults::OK, the options can be retrieved by calling XPropertyAccess::getPropertyValues.

Exported Interfaces - Details
::com::sun::star::beans::XPropertyAccess
Description
this interface is used to set the property values of the ::com::sun::star::document::MediaDescriptor before executing the dialog and to retrieve the changed ::com::sun::star::document::MediaDescriptor afterwards.
XExecutableDialog
Description
this interface executes a dialog that displays the options for a filter. If XExecutableDialog::execute returns ExecutableDialogResults::OK, the options can be retrieved by calling XPropertyAccess::getPropertyValues.

 
Top of Page

Apache Software Foundation

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

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