ArcGIS Pro 3.0 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / BuildingSceneLayer Class / SetActiveFilter Method
The filter id of the filter to set active
Example

In This Topic
    SetActiveFilter Method
    In This Topic
    Sets the active filter to be the filter with the given filter id This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public void SetActiveFilter( 
       string filterID
    )
    Public Sub SetActiveFilter( _
       ByVal filterID As String _
    ) 

    Parameters

    filterID
    The filter id of the filter to set active
    Exceptions
    ExceptionDescription
    This method or property must be called within the lambda passed to QueuedTask.Run.
    filter not found
    Remarks
    If a filter with the given filter id is not found a System.ArgumentException is thrown. Refer to HasFilter
    Example
    Set and Clear Active Filter for BuildingSceneLayer
    //Must be called on the MCT
    //Note: Use HasFilter to check if a given filter id exists in the layer
    //var bsl = ...;
    if (bsl.HasFilter(filter1.ID))
      bsl.SetActiveFilter(filter1.ID);
    var activeFilter = bsl.GetActiveFilter();
    
    //Clear the active filter
    bsl.ClearActiveFilter();
    
    Create a Filter using Building Level and Category
    //Must be called on the MCT
    
    //refer to "Query Building Scene Layer for available Types and Values"
    //...
    //var bsl = ...;
    //At 2.x
    //var dict = bsl.QueryAvailableFieldsAndValues();
    
    //var dict = bsl.GetAvailableFieldsAndValues();
    //var categories = dict.SingleOrDefault(kvp => kvp.Key == "Category").Value;
    //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
    //At 2.x - bsl.SetFilter(fd);
    bsl.UpdateFilter(fd);
    //Set it active. The ID is auto-generated
    bsl.SetActiveFilter(fd.ID);
    
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 8.1

    See Also