FilterProcedure (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage properties / Various properties

Filter procedure

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FilterProcedure (Property)

In french: ProcédureFiltre

The FilterProcedure property allows you to get and modify the procedure used to apply a filter on a row or column header when calculating a Pivot Table control.

Example

// Calculate the content of a pivot table 
// for stores verified by the group <"MaProcFiltre"> 
// from January 1st, 2012
PVT_Statistics1.COL_InvoiceDate.MinValue = "20120101"
PVT_Statistics1.COL_StoreGroup.FilterProcedure = "MyFilterProc"
PVTCalculateAll(PVT_Statistics)

PROCEDURE MyFilterProc(sGroupName is string)
// Ignore the stores found in the "TEST" group
IF sGroupName = "TEST" THEN RESULT False
// Take all the other ones
RETURN True

Syntax

Finding out the name of filter procedure Hide the details

<Result> = <Header to filter>.FilterProcedure

<Result>: Character string

Name of WLanguage procedure used for the filter.

<Header to filter>: Control name

Name of row or column header found in the filtered Pivot Table control.

Modifying the filter procedure associated with the header Hide the details

<Header to filter>.FilterProcedure = <New procedure>

<Header to filter>: Control name

Name of row header or column header found in the filtered pivot table.

<New procedure>: Character string

Name of WLanguage procedure used for the filter.
Empty string to disable the filter.

Remarks

Filter procedure

The filter procedure is used to choose the values that will be taken into account when calculating the Pivot Table control during the call to PVTCalculateAll and PVTCalculateUpdate.

The procedure takes in parameter the value of the key for the row header or column header for which it was defined.

This procedure should return:

True to accept the value
False to reject: the value will not be taken into account in the Pivot Table control field.

This procedure is mainly used to speed up the calculation of the pivot table by reducing the volume to process.

Warning Not to be confused with the PVTFilter function, which applies to the result already calculated and gives a different view of the result displayed.