IXlsCustomFilter

COM interface ( getting help with interfaces )

interface IXlsCustomFilter : IDispatch
{

  [id(1), propput] HRESULT CustomExpression([in]BSTR expression);
  [id(2)         ] HRESULT TopValues([in]int n);
  [id(3)         ] HRESULT BottomValues([in]int n);
  [id(4)         ] HRESULT TopPercent([in]int percent);
  [id(5)         ] HRESULT BottomPercent([in]int percent);
  [id(6)         ] HRESULT AboveAverage();
  [id(7)         ] HRESULT BelowAverage();
  [id(8)         ] HRESULT MatchBlanks();
  [id(9)         ] HRESULT MatchNonBlanks();
  [id(10)        ] HRESULT MatchValues([in]BSTR values);
  [id(11)        ] HRESULT MatchStyle([in]IXlsStyle* style);
  [id(12)        ] HRESULT MatchOppositeStyle([in]IXlsStyle* style);
  [id(13)        ] HRESULT Delete();

}

HRESULT CustomExpression([in]BSTR expression);
sets and applies the custom filter expression. Examples : "< 30", "<> 100 AND > 500", "= "USA"", "<> "**RA**" OR = "exc"". Strings must be surrounded with double-quotes. String wildcards * and ? supported. Only up to two conditions in the expression (Excel limitation).

HRESULT TopValues([in]int n);
sets the filter to top n values.

HRESULT BottomValues([in]int n);
sets the filter to bottom n values.

HRESULT TopPercent([in]int percent);
sets the filter to top n percent values. Example : 30 means 30% of top values.

HRESULT BottomPercent([in]int percent);
sets the filter to bottom n values. Example : 30 means 30% of bottom values.

HRESULT AboveAverage();
sets the filter to values above the average. The average is automatically computed.

HRESULT BelowAverage();
sets the filter to values below the average. The average is automatically computed.

HRESULT MatchBlanks();
sets the filter to match blank values.

HRESULT MatchNonBlanks();
sets the filter to match non-blank values.

HRESULT MatchValues([in]BSTR values);
sets the values to match the filter against. Values must be semi-colon (;) separated. This filter is mutually exclusive from all others.

HRESULT MatchStyle([in]IXlsStyle* style);
sets the filter to the formatting style passed in parameter. Example : match by background color.

HRESULT MatchOppositeStyle([in]IXlsStyle* style);
sets the filter to hide cells that do not match the formatting style passed in parameter. Example : match by background color.

HRESULT Delete();
deletes the custom filter.