interface XFilterManager in module com::sun::star::ui::dialogs::

(Global Index)

Syntax

interface XFilterManager : com::sun::star::uno::XInterface ;

Description

Specifies a filter manager interface for a FilePicker

Method Summary

appendFilter Adds a filter identified by a title.

setCurrentFilter Sets the current filter.

getCurrentFilter Returns the currently selected filter.

Known Services Which Export this Interface

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

Method Details



appendFilter

Syntax

void appendFilter (
string aTitle,
string aFilter )
raises ( com::sun::star::lang::IllegalArgumentException );

Description

Adds a filter identified by a title.

Parameter aTitle

Specifies the name of the filter as shown in the filter box of the FilePicker dialog.

Parameter aFilter

Specifies the extensions of the filter. Multiple filters should be semicolon separated. The semicolon may not be used as character in a filter expresion. A typical filter is for instance ' * .txt'.

Throws

::com::sun::star::lang::IllegalArgumentException If a filter with the specified title already exists.

setCurrentFilter

Syntax

void setCurrentFilter (
string aTitle )
raises ( com::sun::star::lang::IllegalArgumentException );

Description

Sets the current filter.

Parameter aTitle

Specifies the name of the filter to be set.

Throws

com::sun::star::lang::IllegalArgumentException If the specified filter was not found.

getCurrentFilter

Syntax

string getCurrentFilter ();

Description

Returns the currently selected filter.

Returns

The the name of the selected filter or an empty string if there is no filter or no filter is currently selected.
Top of Page