ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / FilterDefinition Class / Description Property
Example

In This Topic
    Description Property (FilterDefinition)
    In This Topic
    Gets or sets the filter description.
    Syntax
    Public Property Description As String
    public string Description {get; set;}
    Example
    Modify BuildingSceneLayer Filter Name and Description
    {
      // Note: call within QueuedTask.Run()
      {
    
        filter.Name = "Updated Filter Name";
        filter.Description = "Updated Filter description";
        bsl.UpdateFilter(filter);
      }
    }
    Create a Filter using Building Level and Category
    {
      // Note: call within QueuedTask.Run()
      {
        //refer to "Query Building Scene Layer for available Types and Values
        var dict = bsl.GetAvailableFieldsAndValues();
        var categories = dict.SingleOrDefault(kvp => kvp.Key == "Category").Value;
        //get a list of existing floors or "levels"
        var floors = dict.SingleOrDefault(kvp => kvp.Key == "BldgLevel").Value;
    
        //Make a new filter definition
        var fd = new FilterDefinition()
        {
          Name = "Floor and Category Filter",
          Description = "Example filter",
        };
        //Set up the values for the filter
        var filtervals = new Dictionary<string, List<string>>();
        filtervals.Add("BldgLevel", new List<string>() { floors[0] });
        var category_vals = categories.Where(v => v == "Walls" || v == "Stairs").ToList() ?? new List<string>();
        if (category_vals.Count() > 0)
        {
          filtervals.Add("Category", category_vals);
        }
        //Create a solid block (other option is "Wireframe")
        var fdef = new FilterBlockDefinition()
        {
          FilterBlockMode = Object3DRenderingMode.None,
          Title = "Solid Filter",
          SelectedValues = filtervals//Floor and Category
        };
        //Apply the block
        fd.FilterBlockDefinitions = new List<FilterBlockDefinition>() { fdef };
        //Add the filter definition to the layer
        bsl.UpdateFilter(fd);
        //Set it active. The ID is auto-generated
        bsl.SetActiveFilter(fd.ID);
      }
    }
    Requirements

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

    ArcGIS Pro version: 3.0 or higher.
    See Also