RemoveFilter Method—ArcGIS Pro

RemoveFilter Method

In This Topic

Removes the filter with the given filter id. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void RemoveFilter( 
   string filterID
)

Public Sub RemoveFilter( _
   ByVal filterID As String _
)

Parameters

filterID: The filter id of the filter to remove

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	filter not found

Remarks

If a filter with the given filter id is not found a System.ArgumentException is thrown. Refer to HasFilter
If the filter to be removed is currently the active filter, it is cleared first.

Example

Remove BuildingSceneLayer Filter

//var bsl = ...;
//Note: Use HasFilter to check if a given filter id exists in the layer
//Must be called on the MCT
if (bsl.HasFilter(filter1.ID))
  bsl.RemoveFilter(filter1.ID);
//Or remove all filters
bsl.RemoveAllFilters();

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

BuildingSceneLayer Class
BuildingSceneLayer Members

Send feedback