GETFILTER Function (Query)

Returns the filters that are set on the field of a specified column in the query.

The following code shows the syntax of the GETFILTER function. Query is a variable of the Query data type that specifies the query object.

Syntax

  
Filter := Query.GETFILTER(Column)  

Parameters

Column
Type: Text

The name of the column in the query. A column name is defined by the Name Property in Query Designer.

Return Value

Type: Text

A text string that lists all the filters that are set on the column of the query. If there are no filters, then an empty string is returned.

Remarks

The GETFILTER function returns the filters that are currently set for a data column or filter row by the SETFILTER Function (Query) function, SETRANGE Function (Query) function, and the column's ColumnFilter Property in Query Designer. The GETFILTER function does not return filters that are set on a column's source field by the DataItemTableFilter Property in Query Designer or global filters that are set by the FILTERGROUP function.

Note

A filter row is row in Query Designer that is used to filter on a field that is not included in the resulting dataset. For more information, see Understanding Query Filters and How to: Set Up Filter Rows in Query Designer.

You can call the GETFILTER function multiple times and at any point in the code. If you call the GETFILTER function before the SETFILTER or SETRANGE function, then the GETFILTER function returns only filters on the column that are set by the column's ColumnFilter property.

Filters that are set by the SETFILTER function and SETRANGE function are applied to a query when the query is opened with a call to the OPEN, SAVEASXML, or SAVEASCSV functions. You must consider the location of the GETFILTERS function with respect to these functions to obtain the desired results. For example, in the following two code examples, the GETFILTER function will return the filter that is set by the SETFILTER function. 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.GETFILTER(Column);  
Query.READ;  

Query.OPEN;   
Query.SETFILTER(Column, String);  
Query.GETFILTER(Column);  
Query.READ;  

Example

The following C/AL code example demonstrates how to use the GETFILTER function on a query. The example code sets a filter 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 do the following:

1. 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.

     For step-by-step instructions for creating this query, see Walkthrough: Creating a Query to Link Two Tables.

   • The ColumnFilter property of the Quantity column is set to include values greater than 5.

2. Create the following C/AL variables and text constant in the object that will run the query, such as a codeunit.

   Variable name	DataType	Subtype
   MyQuery	Query	Customer_SalesQuantity
   MyFilter	Text	Not applicable

   Text constant name	ENU Value
   Text000	The filter is: %1

   The following C/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 a codeunit, and then run the codeunit to see the results.

// Sets a filter to display only sales quantities greater than 10. This overwrites the ColumnFilter property.  
MyQuery.SETFILTER(Quantity, '>10');  
// Runs the query and applies the filter.  
MyQuery.OPEN;  
// Returns the filter on the Quantity column and displays the filter in a message.  
MyFilter := MyQuery.GETFILTER(Quantity);  
MESSAGE(Text000, MyFilter);  

Running the code returns the following message:

The filter is: Quantity > 10