SetFilterWhereClause Method (RealtimeTable)

In This Topic

Sets a filter this table so that only rows matching this filter will be streamed by the service. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetFilterWhereClause( 
   string filterWhereClause
)

Public Sub SetFilterWhereClause( _
   ByVal filterWhereClause As String _
)

Parameters

filterWhereClause: A string representing SQL where clause.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

Filters applied on the table are not persisted. They are in-memory only. To persist a filter, use the equivalent SetDefinitionQuery(...) method on the StreamLayer

Check RealtimeDatastore.GetFilterSQLSyntax to find out SQL syntax and supported functionality for the real-time datasource.

Setting a filter removes all existing rows and starts from blank with the new filter.

It is not a filter that gets applied on the client side, rather it gets set to the connection itself and realtime service only streams rows that match this criteria.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

RealtimeTable Class
RealtimeTable Members

Send feedback