ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / BasicFeatureLayer Class / IsValidDefinitionQuery Method / IsValidDefinitionQuery(DefinitionQuery) Method
The definition query to check.
Example

In This Topic
    IsValidDefinitionQuery(DefinitionQuery) Method
    In This Topic
    Determines if the specified definitionQuery is valid. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public Task<bool> IsValidDefinitionQuery( 
       DefinitionQuery definitionQuery
    )
    Public Overloads Function IsValidDefinitionQuery( _
       ByVal definitionQuery As DefinitionQuery _
    ) As Task(Of Boolean)

    Parameters

    definitionQuery
    The definition query to check.

    Return Value

    True if valid.
    Exceptions
    ExceptionDescription
    This method or property must be called within the lambda passed to QueuedTask.Run.
    Remarks
    This method does not check whether records will be returned from the definitionQuery; just whether the query where clause has valid syntax for the layer and the spatial filter (if defined) is valid.
    Example
    Apply a Definition Query Filter to a Feature Layer
    {
      var us_parks = map.GetLayersAsFlattenedList()
                        .OfType<FeatureLayer>().First(l => l.Name == "USNationalParks");
    
      var sql = "STATE_ABBR = 'CA'";
      var isValid = await us_parks.IsValidDefinitionQuery(sql);
      if (isValid)
      {
        await QueuedTask.Run(() =>
        {
          var def_query = new DefinitionQuery("CaliforniaParks", sql);
    
          us_parks.InsertDefinitionQuery(def_query);
          us_parks.SetDefinitionQuery("STATE_ABBR = 'CA'");
    
          //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 to a Feature Layer Option 2
    {
      var us_parks = map.GetLayersAsFlattenedList()
            .OfType<FeatureLayer>().First(l => l.Name == "USNationalParks");
    
      var sql = "STATE_ABBR = 'CA'";
      var isValid = await us_parks.IsValidDefinitionQuery(sql);
      if (isValid)
      {
        //inserts a new definition query and makes it active
        //it will be assigned a unique name
        us_parks.SetDefinitionQuery(sql);
      }
    }
    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");
      //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 = await QueuedTask.Run(() =>
        usa_states.GetFeatureOutline(mapView, FeatureOutlineType.Visible));
      //other options...
      //var filter_geom = usa_states.GetFeatureOutline(mapView, FeatureOutlineType.All);
      //var filter_geom = usa_states.GetFeatureOutline(mapView, FeatureOutlineType.Selected);
    
      //Geometry must have a valid SR and be point, multi-point, line, or poly
      await QueuedTask.Run(() =>
      {
        if (def_query.CanSetFilterGeometry(filter_geom))
        {
          def_query.SetFilterGeometry(filter_geom);
        }
      });
    
      // test to ensure the definition query is valid
      var isValid = await greatLakes.IsValidDefinitionQuery(def_query);
      if (isValid)
      {
        await QueuedTask.Run(() =>
        {
          //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 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.8 or higher.
    See Also