Fix issue with custom filters not working for control lookup

GetElementMatchingCriteria is invoked with a collection of UIControl. However, different control entitie initialize filter argument with different types e.g. AutomationElement, IWebElment, etc. This causes a mismatch and script fails to execute. To adresss this we can either initialize filter argument with type of UIControl for all type of ControlEntity or each ControlEntity must ensure to invoke GetElementMatchingCriteria by converting collection of UIControl to collection of api control e.g. collection of AutomationElement.
We decided on the first approach as it provides access to all the methods availble on UIControl. However, if someone needs access to the actual API controls, they need to add additional imports and reference before they can use UIControl.GetApiControl<T> which is a bit incovenient if frequently required.

Author: Nfactor26

src/Pixel.Automation.Core.Components/Entities/ControlEntity.cs

@@ -134,7 +134,16 @@ public IControlIdentity ControlDetails
 
         }
 
-        protected abstract void InitializeFilter();
+        /// <summary>
+        /// Initialize the Filter Argument.
+        /// </summary>
+        protected virtual void InitializeFilter()
+        {
+            if (this.Filter == null)
+            {
+                this.Filter = new PredicateArgument<UIControl>() { CanChangeType = false };
+            }
+        }
 
         public ControlEntity(string name = "Control Entity", string tag = "ControlEntity") : base(name, tag)
         {

src/Pixel.Automation.Image.Matching.Components/ImageControlEntity.cs

@@ -84,16 +84,7 @@ public ImageSearchScope ImageSearchScope
     [DataMember]
     [Display(Name = "Area on screen", GroupName = "Search Strategy", Order = 15)]
     [Description("Target window within which image lookup will be restricted")]    
-    public Argument AreaOnScreen { get; set; } = new InArgument<BoundingBox>() { Mode = ArgumentMode.DataBound };
-
-    ///<inheritdoc/>
-    protected override void InitializeFilter()
-    {
-        if (this.Filter == null)
-        {
-            this.Filter = new PredicateArgument<BoundingBox>() { CanChangeType = false };
-        }
-    }
+    public Argument AreaOnScreen { get; set; } = new InArgument<BoundingBox>() { Mode = ArgumentMode.DataBound };  
 
     ///<inheritdoc/>
     public override async Task<UIControl> GetControl()

src/Pixel.Automation.Java.Access.Bridge.Components/JavaControlEntity.cs

@@ -1,12 +1,10 @@
-using Pixel.Automation.Core.Arguments;
-using Pixel.Automation.Core.Components;
+using Pixel.Automation.Core.Components;
 using Pixel.Automation.Core.Controls;
 using Pixel.Automation.Core.Enums;
 using Serilog;
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using WindowsAccessBridgeInterop;
 
 namespace Pixel.Automation.Java.Access.Bridge.Components
 {
@@ -15,15 +13,7 @@ public class JavaControlEntity : ControlEntity
         private readonly ILogger logger = Log.ForContext<JavaControlEntity>();
 
         private UIControl control;
-
-        protected override void InitializeFilter()
-        {
-            if (this.Filter == null)
-            {
-                this.Filter = new PredicateArgument<AccessibleContextNode>();
-            }
-        }
-
+      
         /// <summary>
         /// Clear the located control once entity is processed
         /// </summary>

src/Pixel.Automation.UIA.Components/WinControlEntity.cs

@@ -1,13 +1,11 @@
 extern alias uiaComWrapper;
-using Pixel.Automation.Core.Arguments;
 using Pixel.Automation.Core.Components;
 using Pixel.Automation.Core.Controls;
 using Pixel.Automation.Core.Enums;
 using Serilog;
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using uiaComWrapper::System.Windows.Automation;
 
 namespace Pixel.Automation.UIA.Components
 {
@@ -16,15 +14,7 @@ public class WinControlEntity : ControlEntity
         private readonly ILogger logger = Log.ForContext<WinControlEntity>();
 
         private UIControl control;
-        
-        protected override void InitializeFilter()
-        {
-            if (this.Filter == null)
-            {
-                this.Filter = new PredicateArgument<AutomationElement>();
-            }
-        }
-
+       
         /// <summary>
         /// Clear the located control once entity is processed
         /// </summary>

src/Pixel.Automation.Web.Playwright.Components/WebControlEntity.cs

@@ -11,15 +11,7 @@ public class WebControlEntity : ControlEntity
     {
         private readonly ILogger logger = Log.ForContext<WebControlEntity>();
 
-        private UIControl control;
-
-        protected override void InitializeFilter()
-        {
-            if (this.Filter == null)
-            {
-                this.Filter = new PredicateArgument<ILocator>();
-            }
-        }
+        private UIControl control;     
 
         /// <summary>
         /// Clear the located control once entity is processed

src/Pixel.Automation.Web.Selenium.Components/WebControlEntity.cs

@@ -1,5 +1,4 @@
 using OpenQA.Selenium;
-using Pixel.Automation.Core.Arguments;
 using Pixel.Automation.Core.Components;
 using Pixel.Automation.Core.Controls;
 using Pixel.Automation.Core.Enums;
@@ -17,14 +16,6 @@ public class WebControlEntity : ControlEntity
 
     private UIControl control;
 
-    protected override void InitializeFilter()
-    {
-        if (this.Filter == null)
-        {
-            this.Filter = new PredicateArgument<IWebElement>();
-        }
-    }
-
     /// <summary>
     /// Clear the located control once entity is processed
     /// </summary>