InsertDefinitionQuery Method (BasicFeatureLayer)

In This Topic

Inserts a DefinitionQuery. If is true, makes it the active definition query. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void InsertDefinitionQuery( 
   DefinitionQuery definitionQuery,
   bool makeActive
)

Public Sub InsertDefinitionQuery( _
   ByVal definitionQuery As DefinitionQuery, _
   Optional ByVal makeActive As Boolean _
)

Parameters

definitionQuery: A DefinitionQuery object.
makeActive: A boolean to indicate it should be the active definition query.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.InvalidOperationException	A definition query with the same name already exists in the list.
System.InvalidOperationException	Where clause of the definitionQuery is empty.

Remarks

The DefinitionQuery.Name of the cannot already exist in the list of DefinitionQueries. When Name is empty, an automatically generated name gets assigned.The DefinitionQuery.WhereClause cannot be empty.

Example

Querying a feature layer with a spatial filter

          // Note: Run within QueuedTask.Run
          // Set the spatial filter geometry

          //Get the geometry from the selected features in the feature layer
          var spatialClauseGeom = spatialDefnLayer.GetFeatureOutline(MapView.Active, FeatureOutlineType.Selected);

DefinitionQuery definitionQuery = new DefinitionQuery
{
  WhereClause = whereClause,
  Name = $"{layerToQuery.Name}"
};
//Setting the spatial filter to the Definition Query
if (definitionQuery.CanSetFilterGeometry(spatialClauseGeom))
{
  definitionQuery.SetFilterGeometry(spatialClauseGeom);
}

layerToQuery.InsertDefinitionQuery(definitionQuery);
layerToQuery.SetActiveDefinitionQuery(definitionQuery.Name);

Apply A Definition Query Filter to a Feature Layer

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

      QueuedTask.Run(() =>
{
  var def_query = new DefinitionQuery("CaliforniaParks",
                        "STATE_ABBR = 'CA'");

          us_parks.InsertDefinitionQuery(def_query);
          //Set it active
          us_parks.SetActiveDefinitionQuery(def_query.Name);

          //or....also - set it active when it is inserted
          //us_parks.InsertDefinitionQuery(def_query, true);
      });

Apply A Definition Query Filter With a Filter Geometry to a Feature Layer

    var greatLakes = map.GetLayersAsFlattenedList()
                .OfType<FeatureLayer>().First(l => l.Name == "Great Lakes");
    var usa_states = map.GetLayersAsFlattenedList()
    .OfType<FeatureLayer>().First(l => l.Name == "US_States");

    QueuedTask.Run(() =>
    {
//name must be unique
        var def_query = new DefinitionQuery("GreatLakes",
                                                    "NAME in ('Huron','Michigan','Erie')");

        //create a filter geometry - in this example we will use the outline geometry
        //of all visible features from a us states layer...the filter geometry will be
//intersected with the layer feature geometry when added to the def query
        var filter_geom = usa_states.GetFeatureOutline(mv, FeatureOutlineType.Visible);
        //other options...
        //var filter_geom = usa_states.GetFeatureOutline(mv, FeatureOutlineType.All);
        //var filter_geom = usa_states.GetFeatureOutline(mv, FeatureOutlineType.Selected);

        //Geometry must have a valid SR and be point, multi-point, line, or poly
        if (def_query.CanSetFilterGeometry(filter_geom))
{
  def_query.SetFilterGeometry(filter_geom);
}

        //Apply the def query
        greatLakes.InsertDefinitionQuery(def_query);
        //Set it active
        greatLakes.SetActiveDefinitionQuery(def_query.Name);

        //or....also - set it active when it is inserted
        //greatLakes.InsertDefinitionQuery(def_query, true);
    });

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

BasicFeatureLayer Class
BasicFeatureLayer Members

Send feedback