ElementAssistant.cs

// =============================================================================
// GPAL - Generally Positive Automation Library
// Copyright © 2026 Software Decisions, Inc. All rights reserved.
//
// This file is part of GPAL.
// Licensed under the Business Source License 1.1
//
// Primary development, architecture, and vision by Michael B. Vederman,
// CEO of Software Decisions, Inc., Texas.
//
// Internal development maintained privately.
// Public releases appear on GitHub: https://github.com/SoftwareDecisionsInc/GPAL.
//
// See LICENSE for full terms, including Additional Use Grant.
// =============================================================================
 
using OpenQA.Selenium;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using static GenerallyPositive.Enums;
 
namespace GenerallyPositive.Application
{
    public class ElementAssistant : IAllowForSelector, IAllowElementSettingsAndActions
    {
        private ElementSettings ElementSettings { get; set; }

        internal ElementAssistant()
        {
            ElementSettings = new ElementSettings();
        }
        public IAllowElementSettingsAndActions WithHardware
        {
            get
            {
                ElementSettings.InteractionType = InteractionType.Hardware;
                return this;
            }
        }

        public IAllowElementSettingsAndActions LeftClick()
        {
            if (InteractionType.Hardware == ElementSettings.InteractionType)
                ElementHelper.HardwareClick(Application, ElementSettings.AutomationElement, ClickType.LeftClick, ModifierKeys.NONE);
            else
                ElementHelper.UIAutomationClick(Application, ElementSettings.Selector, ElementSettings.AutomationElement, ClickType.LeftClick, ModifierKeys.NONE);
 
            Thread.Sleep(250);
            return this;
        }

        public IAllowElementSettingsAndActions LeftClick(Enums.ModifierKeys modifierKeys)
        {
            if (InteractionType.Hardware == ElementSettings.InteractionType)
                ElementHelper.HardwareClick(Application, ElementSettings.AutomationElement, ClickType.LeftClick, modifierKeys);
            else
                ElementHelper.UIAutomationClick(Application, ElementSettings.Selector, ElementSettings.AutomationElement, ClickType.LeftClick, modifierKeys);
 
            Thread.Sleep(250);
            return this;
        }

        public IAllowElementSettingsAndActions LeftDoubleClick()
        {
            if (InteractionType.Hardware == ElementSettings.InteractionType)
                ElementHelper.HardwareClick(Application, ElementSettings.AutomationElement, ClickType.LeftDoubleClick, ModifierKeys.NONE);
            else
            {
                ElementHelper.UIAutomationClick(Application, ElementSettings.Selector, ElementSettings.AutomationElement, ClickType.LeftDoubleClick, ModifierKeys.NONE);
            }
 
            Thread.Sleep(250);
            return this;
        }

        public IAllowElementSettingsAndActions RightClick()
        {
            if (InteractionType.Hardware == ElementSettings.InteractionType)
                ElementHelper.HardwareClick(Application, ElementSettings.AutomationElement, ClickType.RightClick, ModifierKeys.NONE);
            else
            {
                ElementHelper.UIAutomationClick(Application, ElementSettings.Selector, ElementSettings.AutomationElement, ClickType.RightClick, ModifierKeys.NONE);
            }
 
            Thread.Sleep(250);
            return this;
        }

        public IAllowElementSettingsAndActions ScrollHorizontal(System.Windows.Automation.ScrollAmount scrollAmount)
        {
            ElementHelper.Scroll(Application, scrollAmount, ScrollTypes.Increments, ScrollTypes.Horizontal);
            return this;
        }

        public IAllowElementSettingsAndActions ScrollHorizontalPercent(int percent)
        {
            ElementHelper.Scroll(Application, percent, ScrollTypes.Percent, ScrollTypes.Horizontal);
            return this;
        }

        public IAllowElementSettingsAndActions ScrollVertical(System.Windows.Automation.ScrollAmount scrollAmount)
        {
            ElementHelper.Scroll(Application, scrollAmount, ScrollTypes.Increments, ScrollTypes.Vertical);
            return this;
        }

        public IAllowElementSettingsAndActions ScrolVerticalPercent(int percent)
        {
            ElementHelper.Scroll(Application, percent, ScrollTypes.Percent, ScrollTypes.Vertical);
            return this;
        }

        public IAllowElementSetting ForSelector(Selector selector)
        {
            ElementSettings.Selector = selector;
            ElementSettings.InteractionType = selector.InteractionType;
            return this;
        }

 
        public IAllowElementSettingsAndActions WithElement(IGPALAutomationElement AutomationElement)
        {
            ElementSettings.AutomationElement = (GPALAutomationElement)AutomationElement;
            return this;
        }

        public IAllowElementSettingsAndActions FillInFrom(string inputText)
        {
            UnitOfWork.ElementNode elementNode = new UnitOfWork.ElementNode() { OffsetX = (int)(ElementSettings.Selector?.OffsetX ?? 5), OffsetY = (int)(ElementSettings.Selector?.OffsetY ?? 5), InteractionType = ElementSettings.InteractionType }; // if .ForSelector is not provided, default to 5
            ElementHelper.FillInFrom(Application, ElementSettings.AutomationElement.Ae, elementNode, inputText, WriteMode.Overwrite);
 
            return this;
        }

        public IAllowElementSettingsAndActions InsertFrom(string inputText)
        {
            ElementHelper.FillInFrom(Application, inputText, WriteMode.Insert);
 
            return this;
        }

        public IAllowElementSettingsAndActions AppendFrom(string inputText)
        {
            UnitOfWork.ElementNode elementNode = new UnitOfWork.ElementNode() { OffsetX = (int)(ElementSettings.Selector?.OffsetX ?? 5), OffsetY = (int)(ElementSettings.Selector?.OffsetY ?? 5), InteractionType = ElementSettings.InteractionType }; // if .ForSelector is not provided, default to 5
            ElementHelper.FillInFrom(Application, ElementSettings.AutomationElement.Ae, elementNode, inputText, WriteMode.Append);
 
            return this;
        }

        public IAllowElementSettingsAndActions SendKeyCode(byte keyCode)
        {
            HardwareHelper.SendKey(keyCode);
            return this;
        }

        public IAllowElementSettingsAndActions PressModifierKey(ModifierKeys modifierKeys)
        {
            if (ModifierKeys.NONE != modifierKeys)
                HardwareHelper.PressModifierKey(modifierKeys);
            return this;
        }

        public IAllowElementSettingsAndActions ReleaseModifierKey(ModifierKeys modifierKeys)
        {
            if (ModifierKeys.NONE != modifierKeys)
                HardwareHelper.ReleaseModifierKeys(modifierKeys);
            return this;
        }

        internal Application Application
        {
            get
            {
                return ElementSettings.Application;
            }
 
            set
            {
                ElementSettings.Application = value;
            }
        }
    }
}