Share via

FindFilter Class

  • Article

FindFilter Class

Contains the filter used when finding points-of-interest and polygons. Specifies the entity type, properties, and property values that the returned results must match.


Public Class FindFilter Inherits System.Object


[C#]

public class FindFilter : System.Object

Public Properties

Name Description
public propertyEntityTypeName

A string representing the name of the entity type (EntityType.Name property) that the results returned from the point-of-interest and polygon find methods must match.
public propertyExpression

A complex logical expression (object) used to filter the find results returned by the point-of-interest and polygon find methods.
public propertyPropertyNames

An array of strings representing the property names (EntityProperty.Name property) of the selected entity type that the results returned from the point-of-interest and polygon find methods must match.
public propertySortProperties

Array of entity property names (as an array of objects) used for sorting the find results returned from the point-of-interest and polygon find methods .
public propertyWhereClause

A value filter to apply to the results (WhereClause object) returned from the point-of-interest find and polygon methods. The WhereClause defines the entity property/value pairs that the results returned from the point-of-interest find and polygon methods must match.

Remarks

  • The FindFilter object is used in the following methods:

  • For the FindFilter object to be valid, the EntityTypeName property must contain a value. If the PropertyNames property is null, all properties are returned.

  • If the WhereClause and Expression properties are both null, all entities are returned (for the FindByID, FindNearby, FindNearRoute, and FindPolygon methods), regardless of their property values; an exception is thrown for the FindByProperty method.

  • To retrieve the entity types for a specific data source, use the CommonServiceSoap.GetEntityTypes method.

  • The WhereClause property and the Expression property are mutually exclusive; when both properties are assigned values, an exception is thrown.

  • You can also use this class to filter entities using the standard properties such as MatchedMethod and MatchCode .

See Also

  FindServiceSoap Class   |   EntityType.Name Property   |   EntityProperty.Name Property   |   FilterExpression Class   |   SortProperty Class   |   WhereClause Class   |   FindNearbySpecification.Filter Property   |   FindByProperty.Filter Property   |   FindByIDSpecification.Filter Property   |   FindNearRouteSpecification.Filter Property