Query.GetFilters() Method

Article
02/26/2024

Version: Available or changed with runtime version 1.0.

Returns the filters that are applied to all columns in the query. The following code shows the syntax of the GETFILTERS method. Query is a variable of the Query data type that specifies the query object.

Syntax

Filter :=   Query.GetFilters()

Note

This method can be invoked using property access syntax.

Parameters

Query
Type: Query
An instance of the Query data type.

Return Value

Filter
Type: Text
All filters of the query

Remarks

The GetFilterS method returns the filters that are currently set for all data columns and filter rows by the SetFilter Method (Query) method, SetRange Method (Query)method, and the ColumnFilter Property. The GetFilter method does not return filters that are set on a column's source field by the DataItemTableFilter Property or global filters that are set by the FilterGroup method.

You can call the GetFilterS method multiple times and at any point in the code. If you call the GetFilterS method before the first SetFilter or SetRange method call, then the GetFilterS method returns only filters that are set by the ColumnFilter property of the columns.

Filters that are set by the SetFilter method and SetRange method are applied to a query when the query is opened by using a call to the Open, the SaveAsXML, or SaveAsCSV methods. You must consider the location of the GetFilterS method with respect to these methods to obtain the results that you want. For example, in the following two code examples, the GetFilterS method will return the filter set by the SetFilter method call. However, in the first example, the filter has been applied to the query dataset; in the second example, the filter has not been applied.

Query.SetFilter(Column, String);  
Query.Open;   
Query.GetFilterS;  
Query.Read;

Query.Open;   
Query.SetFilter(Column, String);  
Query.GetFilterS;  
Query.Read;

Example

The following AL code example demonstrates how to use the GetFilterS method on a query. The example code sets filters on a query column, and then displays a message when the query is run that indicates the filter on the column.

This example requires that you create a query called Customer_SalesQuantity that has the following characteristics:

Links table 18 Customer with table 37 Sales Lines from the CRONUS International Ltd. demonstration database.
Includes columns for the Name and No. fields from the Customer table and the Quantity field from Sales Lines table.
The ColumnFilter property of the Quantity column is set with a filter that includes values greater than 10.

The following AL code runs the query and displays a message that contains the filter that is set on a query column. You can add the code to the OnRun trigger of a codeunit, and then run the codeunit to see the results.

var
    MyQuery: Query "Customer SalesQuantity";
    MyFilter: Text;
    Text000: Label 'The filters are as follows: %1';
begin
    // Sets a filter to display only sales quantities greater than 10. This overwrites the value of ColumnFilter property.  
    MyQuery.SetFilter(Quantity, '>10');  
    // Sets a filter to display the columns with the value Selangorian Ltd. only.  
    MyQuery.SetFilter(Name, 'Selangorian Ltd.');  
    // Runs the query and applies the filter.  
    MyQuery.Open;  
    // Returns the filters that are on the Quantity column and displays the filters in a message.  
    MyFilters := MyQuery.GetFilterS;  
    Message(Text000, MyFilters);  
end;

Running the code returns the following message:

The filters are as follows: Quantity > 10, Name = Selangorian Ltd.