Filter
eTag: Filter
When used with specific combinations of attributes, the Filter function lets you automate the various Filter functions available in column headers. Use the Filter action to add filters to a column referenced by its unique ID.
<Filter columnID="A0" ..../>
XML
Tag Attributes
Attributes | Attribute Values | Value Description | Comment |
---|---|---|---|
Target | N/A | Grid code name | N/A |
Remove | True/False | If true, the filtered rows are also removed from the grid forever. The clear filter or grid reset will not bring them back. All the regular rules of filters apply regarding hierarchies, groups etc. (e.g. a filtered out parent in a hierarchy also make its children filtered out: the parent is removed from the grid, the children are removed from the grid). | N/A |
Detailed Description
Action parameters depend on the type of filter: The Value attribute specifies which value is to be used in the comparison process. For regular expressions filters, the expression is affected to the Regex attribute.
The Mode attribute specifies which comparison type is to be executed:
Filter | Mode |
---|---|
Text | Begins |
N/A | NotBegins |
N/A | Equals |
N/A | NotEquals |
N/A | NotEquals |
N/A | Contains |
N/A | NotContains |
N/A | Ends |
N/A | NotEnds |
<Filter columnID="A0" Mode="Equals" Text="-Default-"/>
XML
Number | Equals |
---|---|
N/A | NotEquals |
N/A | GreaterThan |
N/A | GreaterOrEquals |
N/A | LessThan |
N/A | LessOrEquals |
<Filter columnID="I19" Mode="Equals" Number="666"/>
XML
Date & Time | Equals |
---|---|
N/A | NotEquals |
N/A | After |
N/A | AfterOrEquals |
N/A | Before |
N/A | BeforeOrEquals |
N/A | LastFrom |
<Filter columnID="I19" Mode="Equals" Date="2011-01-01"/>
XML
<Filter columnID="I19" Mode="Equals" Time="14:15:12"/>
XML
Cut-off filters:
Possible values:
- Years
- Months
- Days
- Hours
- Minutes
<Filter columnID="D1" Mode="LastFrom" Days="3" Hours="12" />
XML
Value | Any Value (Case sensitive) |
---|---|
ValueExcluded | Any value (case insensitive) to remove from the filters v18 / sapio365 |
Separate multiple values with a colon |
<Filter columnID="D0" Value="LAEC:testcookies"/>
XML
<Filter columnID="D0" ValueExcluded="LAEC:testcookies"/>
XML
NOTE | The only way to filter a check box column is to use the Value filter set to either True or False (the default string renditions of check box fields when copying data into the windows clipboard): |
---|
<Filter columnID="D6" Value="True"/>
XML
Regex | Expression |
---|---|
CashSensitive | True/False |
<Filter columnID="D1" Regex="MuGre" CaseSensitive="false"/>
XML
Filter Out Empty Cells
Empty: True or False
V 16. only
<Filter columnID="D1"Empty="true"/>
XML
Example Script
To definitively remove the rows:
<Filter columnID="A0" .... Remove="True"/>
XML
In sapio365 OneDrive:
<Filter columnID="OBJECTTYPE" Value="Folder"/>
XML