SetDefinitionQuery Method (BasicFeatureLayer)

In This Topic

Sets the where clause of the active definition query. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public DefinitionQuery SetDefinitionQuery( 
   string whereClause
)

Public Function SetDefinitionQuery( _
   ByVal whereClause As String _
) As DefinitionQuery

Parameters

whereClause: A where clause that conforms to SQL standard to filter records.

Return Value

A DefinitionQuery object.

Exceptions

Exception	Description
System.InvalidOperationException	This method cannot be called if the feature layer is a member of SubtypeGroupLayer. Use the IsSubtypeLayer property to determine if the feature layer is a member of a SubtypeGroupLayer.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

If the is null or empty string, then the active query definition is removed and the layer no longer has an active definition query.Where there is an active definition query, this function updates the where clause of tha definition query with the you pass in.If the is non-null, and there is no active definition query, a new definition query with the specified where clause is created and becomes the active definition query. An auto generated name gets assigned. All other definition queries that are not active remain unchanged.Use SetActiveDefinitionQuery to activate or deactivate any existing definition query.

Example

Apply A Definition Query Filter to a Feature Layer2

var us_parks = map.GetLayersAsFlattenedList()
            .OfType<FeatureLayer>().First(l => l.Name == "USNationalParks");

QueuedTask.Run(() =>
{
    //inserts a new definition query and makes it active
    //it will be assigned a unique name
    us_parks.SetDefinitionQuery("STATE_ABBR = 'CA'");
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

BasicFeatureLayer Class
BasicFeatureLayer Members

Send feedback