View Source

Class ContainsFilterBase

Inheritance
System.Object
Namespace: Umbraco.Cms.Api.Delivery.Querying.Filters
Assembly: Umbraco.Cms.Api.Delivery.dll
Syntax
public abstract class ContainsFilterBase : IFilterHandler

Properties

View Source

FieldName

The index field name to filter on.

Declaration
protected abstract string FieldName { get; }
Property Value
Type Description
System.String
View Source

QueryParserRegex

The regex to parse the filter query. Must supply two match groups named "operator" and "value", where "operator" contains the filter operator (i.e. ">") and "value" contains the value to filter on.

Declaration
protected abstract Regex QueryParserRegex { get; }
Property Value
Type Description
System.Text.RegularExpressions.Regex
Remarks

Supported operators:

  • ":" = Is (the filter value equals the index field value)
  • ":!" = IsNot (the filter value does not equal the index field value)
  • ">" = GreaterThan (the filter value is greater than the index field value)
  • ">:" = GreaterThanOrEqual (the filter value is greater than or equal to the index field value)
  • "<" = LessThan (the filter value is less than the index field value)
  • "<:" = LessThanOrEqual (the filter value is less than or equal to the index field value)
Range operators (greater than, less than) only work with numeric and date type filters.

Methods

View Source

BuildFilterOption(String)

Declaration
public FilterOption BuildFilterOption(string filter)
Parameters
Type Name Description
System.String filter
Returns
Type Description
FilterOption
View Source

CanHandle(String)

Declaration
public bool CanHandle(string query)
Parameters
Type Name Description
System.String query
Returns
Type Description
System.Boolean