ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / FeatureLayerCreationParams Class / DefinitionQuery Property
Example

In This Topic
    DefinitionQuery Property (FeatureLayerCreationParams)
    In This Topic
    Gets and sets a definition query with name.
    Syntax
    public DefinitionQuery DefinitionQuery {get; set;}
    Public Property DefinitionQuery As DefinitionQuery
    Example
    Create layer with create-params
    {
      var flyrCreatnParam = new FeatureLayerCreationParams(new Uri(@"c:\data\world.gdb\cities"))
      {
        Name = "World Cities",
        IsVisible = false,
        MinimumScale = 1000000,
        MaximumScale = 5000,
        DefinitionQuery = new DefinitionQuery(whereClause: "Population > 100000", name: "More than 100k"),
        RendererDefinition = new SimpleRendererDefinition()
        {
          SymbolTemplate = SymbolFactory.Instance.ConstructPointSymbol(
         CIMColor.CreateRGBColor(255, 0, 0), 8, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
        }
      };
      var featureLayerWithParams = await QueuedTask.Run(() =>
        LayerFactory.Instance.CreateLayer<FeatureLayer>(flyrCreatnParam, map));
    }
    Create FeatureLayer with a Query Definition
    {
      //The catalog path of the feature layer to add to the map
      var featureClassUriDefinition = new Uri(@"C:\Data\Admin\AdminData.gdb\USA\cities");
      //Define the Feature Layer's parameters.
      var layerParamsQueryDefn = new FeatureLayerCreationParams(featureClassUriDefinition)
      {
        IsVisible = true,
        DefinitionQuery = new DefinitionQuery(whereClause: "STATE_NAME = 'California'", name: "CACities")
      };
      //Create the layer with the feature layer parameters and add it to the active map
      var createdFCWithQueryDefn = await QueuedTask.Run(() =>
        LayerFactory.Instance.CreateLayer<FeatureLayer>(layerParamsQueryDefn, map));
    }
    Create multiple layers with BulkLayerCreationParams 2 - invalid
    {
      // get a feature class that is selected in the catalog pane
      Item item = Project.GetCatalogPane().SelectedItems.FirstOrDefault();
    
      var uriShp = new Uri(@"c:\data\roads.shp");
      var lcpShp = new FeatureLayerCreationParams(uriShp);
      lcpShp.Name = "Roads";
      lcpShp.IsVisible = false;
      lcpShp.DefinitionQuery = new DefinitionQuery("shpQuery", "OBJECTID > 10");
    
      var lcpItem = new FeatureLayerCreationParams(item);
      lcpItem.Name = "Census Polygons";
      lcpItem.IsVisible = true;
    
      // list contains a Uri data source and an Item data source
      // LayerFactory.Instance.CreateLayers will throw an ArgumentException
      var lcps = new List<FeatureLayerCreationParams>();
      lcps.Add(lcpShp);
      lcps.Add(lcpItem);
    
      var blkParams = new BulkLayerCreationParams(lcps);
    
      // LayerFactory.Instance.CreateLayers will thrown an ArgumentException
      // because the LayerCreationParams are created using different
      // types of data sources (1 Uri and 1 Item)
      var layers = await QueuedTask.Run(() => LayerFactory.Instance.CreateLayers(blkParams, map));
    }
    Create multiple layers with BulkLayerCreationParams 2 - Valid
    {
    
      var uriShp = new Uri(@"c:\data\roads.shp");
      var uriSde = new Uri(@"c:\MyDataConnections\MySDE.sde\Census");
      var uri = new Uri(@"http://sampleserver6.arcgisonline.com/arcgis/rest/services/NapervilleShelters/FeatureServer/0");
    
      var lcpShp = new FeatureLayerCreationParams(uriShp);
      lcpShp.Name = "Roads";
      lcpShp.IsVisible = false;
      lcpShp.DefinitionQuery = new DefinitionQuery("shpQuery", "OBJECTID > 10");
    
      var lcpSde = new FeatureLayerCreationParams(uriSde);
      lcpSde.Name = "Census Polygons";
      lcpSde.IsVisible = true;
    
      var lcpService = new FeatureLayerCreationParams(uri);
      lcpService.Name = "Shelters";
      lcpService.IsVisible = true;
      // set some renderer here ...
      //lcpService.RendererDefinition = ...
    
      var lcps = new List<FeatureLayerCreationParams>();
      lcps.Add(lcpShp);
      lcps.Add(lcpSde);
      lcps.Add(lcpService);
    
      var blkParams = new BulkLayerCreationParams(lcps);
      // set the positioning on the BulkLayerCreationParams
      blkParams.MapMemberPosition = MapMemberPosition.Index;
      blkParams.MapMemberIndex = 0;
    
      var layers = await QueuedTask.Run(() => LayerFactory.Instance.CreateLayers(blkParams, map));
    }
    Create multiple layers with BulkLayerCreationParams - Using RollbackBehavior
    {
    
      var uriShp = new Uri(@"c:\data\roads.shp");
      var uriSde = new Uri(@"c:\MyDataConnections\MySDE.sde\Census");
      var uri = new Uri(@"http://sampleserver6.arcgisonline.com/arcgis/rest/services/NapervilleShelters/FeatureServer/0");
    
      var lcpShp = new FeatureLayerCreationParams(uriShp);
      lcpShp.Name = "Roads";
      lcpShp.IsVisible = false;
      lcpShp.DefinitionQuery = new DefinitionQuery("shpQuery", "OBJECTID > 10");
    
      var lcpSde = new FeatureLayerCreationParams(uriSde);
      lcpSde.Name = "Census Polygons";
      lcpSde.IsVisible = true;
    
      var lcpService = new FeatureLayerCreationParams(uri);
      lcpService.Name = "Shelters";
      lcpService.IsVisible = true;
      // set some renderer here ...
      //lcpService.RendererDefinition = ...
    
      var lcps = new List<FeatureLayerCreationParams>();
      lcps.Add(lcpShp);
      lcps.Add(lcpSde);
      lcps.Add(lcpService);
    
      var blkParams = new BulkLayerCreationParams(lcps);
      // set the positioning on the BulkLayerCreationParams
      blkParams.MapMemberPosition = MapMemberPosition.Index;
      blkParams.MapMemberIndex = 0;
    
      // set the rollback behavior
      // - rollback if one or more layers cannot be created due to an invalid data source
      blkParams.RollbackBehavior = LayerCreationRollbackBehavior.RollbackOnMissingLayers;
    
      var layers = await QueuedTask.Run(() => LayerFactory.Instance.CreateLayers(blkParams, map));
    }
    Create a stream layer with a definition query
    {
      await QueuedTask.Run(() =>
      {
        var url = "https://geoeventsample1.esri.com:6443/arcgis/rest/services/AirportTraffics/StreamServer";
        var lyrCreateParam = new FeatureLayerCreationParams(new Uri(url))
        {
          IsVisible = true,
          DefinitionQuery = new DefinitionQuery(whereClause: "RWY = '29L'", name: "Runway")
        };
    
        streamLayer = LayerFactory.Instance.CreateLayer<StreamLayer>(lyrCreateParam, map);
      });
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also