Okapi .NET Library

IFilter Interface

 [This is preliminary documentation and subject to change.]

Filter interface.

For a list of all members of this type, see IFilter Members.

[Visual Basic]
Public Interface IFilter
[C#]
public interface IFilter
[C++]
public __gc __interface IFilter
[JScript]
public interface IFilter

Remarks

This interface provides a common way of reading the localizable information of an input. It also offers the option to re-write the input into a new output at the same time.

Just after creating an object that implements IFilter, you should call the Initialize method. At this point you can query the filter to get more information about the filter: use GetName to retrieve its name, GetIdentifier to retrieve its identifier, or GetDefaultDatatype to know what kind of data it processes.

Use the LoadSettings method to specify which filter, variant and parameters file to use.

The QueryProperty method allows you to detect whether the filter supports or not different types of features.

Requirements

Namespace: Okapi.Library.Filter

Assembly: Okapi.Library.Filter (in Okapi.Library.Filter.dll)

See Also

IFilter Members | Okapi.Library.Filter Namespace | IFilterItem | ILog