How to use GridHeader class of FlaUI.Core.AutomationElements package

Best FlaUI code snippet using FlaUI.Core.AutomationElements.GridHeader

Grid.cs

Source:Grid.cs

...39        public RowOrColumnMajor RowOrColumnMajor => TablePattern.RowOrColumnMajor.Value;40        /// <summary>41        /// Gets the header item.42        /// </summary>43        public virtual GridHeader Header44        {45            get46            {47                var header = FindFirstChild(cf => cf.ByControlType(ControlType.Header));48                return header?.AsGridHeader();49            }50        }51        /// <summary>52        /// Returns the rows which are currently visible to UIA. Might not be the full list (eg. in virtualized lists)!53        /// Use <see cref="GetRowByIndex" /> to make sure to get the correct row.54        /// </summary>55        public virtual GridRow[] Rows56        {57            get58            {59                var rows = FindAllChildren(cf => cf.ByControlType(ControlType.DataItem).Or(cf.ByControlType(ControlType.ListItem)));60                return rows.Select(x => x.AsGridRow()).ToArray();61            }62        }63        /// <summary>64        /// Gets all selected items.65        /// </summary>66        public GridRow[] SelectedItems => SelectionPattern.Selection.Value.Select(x => new GridRow(x.FrameworkAutomationElement)).ToArray();67        /// <summary>68        /// Gets the first selected item or null otherwise.69        /// </summary>70        public GridRow SelectedItem => SelectedItems?.FirstOrDefault();71        /// <summary>72        /// Select a row by index.73        /// </summary>74        public GridRow Select(int rowIndex)75        {76            var gridRow = GetRowByIndex(rowIndex);77            gridRow.Select();78            return gridRow;79        }80        /// <summary>81        /// Select the first row by text in the given column.82        /// </summary>83        public GridRow Select(int columnIndex, string textToFind)84        {85            var gridRow = GetRowByValue(columnIndex, textToFind);86            gridRow.Select();87            return gridRow;88        }89        /// <summary>90        /// Add a row to the selection by index.91        /// </summary>92        public GridRow AddToSelection(int rowIndex)93        {94            var gridRow = GetRowByIndex(rowIndex);95            gridRow.AddToSelection();96            return gridRow;97        }98        /// <summary>99        /// Add a row to the selection by text in the given column.100        /// </summary>101        public GridRow AddToSelection(int columnIndex, string textToFind)102        {103            var gridRow = GetRowByValue(columnIndex, textToFind);104            gridRow.AddToSelection();105            return gridRow;106        }107        /// <summary>108        /// Remove a row from the selection by index.109        /// </summary>110        public GridRow RemoveFromSelection(int rowIndex)111        {112            var gridRow = GetRowByIndex(rowIndex);113            gridRow.RemoveFromSelection();114            return gridRow;115        }116        /// <summary>117        /// Remove a row from the selection by text in the given column.118        /// </summary>119        public GridRow RemoveFromSelection(int columnIndex, string textToFind)120        {121            var gridRow = GetRowByValue(columnIndex, textToFind);122            gridRow.RemoveFromSelection();123            return gridRow;124        }125        /// <summary>126        /// Get a row by index.127        /// </summary>128        public GridRow GetRowByIndex(int rowIndex)129        {130            PreCheckRow(rowIndex);131            var gridCell = GridPattern.GetItem(rowIndex, 0).AsGridCell();132            return gridCell.ContainingRow;133        }134        /// <summary>135        /// Get a row by text in the given column.136        /// </summary>137        public GridRow GetRowByValue(int columnIndex, string value)138        {139            return GetRowsByValue(columnIndex, value, 1).FirstOrDefault();140        }141        /// <summary>142        /// Get all rows where the value of the given column matches the given value.143        /// </summary>144        /// <param name="columnIndex">The column index to check.</param>145        /// <param name="value">The value to check.</param>146        /// <param name="maxItems">Maximum numbers of items to return, 0 for all.</param>147        /// <returns>List of found rows.</returns>148        public GridRow[] GetRowsByValue(int columnIndex, string value, int maxItems = 0)149        {150            PreCheckColumn(columnIndex);151            var gridPattern = GridPattern;152            var returnList = new List<GridRow>();153            for (var rowIndex = 0; rowIndex < RowCount; rowIndex++)154            {155                var currentCell = gridPattern.GetItem(rowIndex, columnIndex).AsGridCell();156                if (currentCell.Value == value)157                {158                    returnList.Add(currentCell.ContainingRow);159                    if (maxItems > 0 && returnList.Count >= maxItems)160                    {161                        break;162                    }163                }164            }165            return returnList.ToArray();166        }167        private void PreCheckRow(int rowIndex)168        {169            if (RowCount <= rowIndex)170            {171                throw new Exception($"Grid contains only {RowCount} row(s) but index {rowIndex} was requested");172            }173        }174        private void PreCheckColumn(int columnIndex)175        {176            if (ColumnCount <= columnIndex)177            {178                throw new Exception($"Grid contains only {ColumnCount} columns(s) but index {columnIndex} was requested");179            }180        }181    }182    /// <summary>183    /// Header element for grids and tables.184    /// </summary>185    public class GridHeader : AutomationElement186    {187        public GridHeader(FrameworkAutomationElementBase frameworkAutomationElement) : base(frameworkAutomationElement)188        {189        }190        public GridHeaderItem[] Columns191        {192            get193            {194                var headerItems = FindAllChildren(cf => cf.ByControlType(ControlType.HeaderItem));195                return headerItems.Select(x => x.AsGridHeaderItem()).ToArray();196            }197        }198    }199    /// <summary>200    /// Header item for grids and tables.201    /// </summary>202    public class GridHeaderItem : AutomationElement203    {204        public GridHeaderItem(FrameworkAutomationElementBase frameworkAutomationElement) : base(frameworkAutomationElement)205        {206        }207        public string Text => Properties.Name.Value;208    }209    /// <summary>210    /// Row element for grids and tables.211    /// </summary>212    public class GridRow : SelectionItemAutomationElement213    {214        public GridRow(FrameworkAutomationElementBase frameworkAutomationElement) : base(frameworkAutomationElement)215        {216        }217        protected IScrollItemPattern ScrollItemPattern => Patterns.ScrollItem.Pattern;218        public GridCell[] Cells219        {220            get221            {222                var cells = FindAllChildren(cf => cf.ByControlType(ControlType.HeaderItem).Not());223                return cells.Select(x => x.AsGridCell()).ToArray();224            }225        }226        public GridHeaderItem Header227        {228            get229            {230                var headerItem = FindFirstChild(ConditionFactory.ByControlType(ControlType.HeaderItem));231                return headerItem?.AsGridHeaderItem();232            }233        }234        /// <summary>235        /// Find a cell by a given text.236        /// </summary>237        public GridCell FindCellByText(string textToFind)238        {239            return Cells.FirstOrDefault(cell => cell.Value.Equals(textToFind));240        }241        public GridRow ScrollIntoView()242        {243            ScrollItemPattern?.ScrollIntoView();244            return this;245        }...

AutomationElementExtensions.cs

Source:AutomationElementExtensions.cs

...15        public ComboBox AsComboBox() { return element.AsComboBox(); }16        public DataGridView AsDataGridView() { return element.AsDataGridView(); }17        public Grid AsGrid() { return element.AsGrid(); }18        public GridCell AsGridCell() { return element.AsGridCell(); }19        public GridHeader AsGridHeader() { return element.AsGridHeader(); }20        public GridHeaderItem AsGridHeaderItem() { return element.AsGridHeaderItem(); }21        public GridRow AsGridRow() { return element.AsGridRow(); }22        public HorizontalScrollBar AsHorizontalScrollBar() { return element.AsHorizontalScrollBar(); }23        public Label AsLabel() { return element.AsLabel(); }24        public ListBox AsListBox() { return element.AsListBox(); }25        public ListBoxItem AsListBoxItem() { return element.AsListBoxItem(); }26        public Menu AsMenu() { return element.AsMenu(); }27        public MenuItem AsMenuItem() { return element.AsMenuItem(); }28        public ProgressBar AsProgressBar() { return element.AsProgressBar(); }29        public RadioButton AsRadioButton() { return element.AsRadioButton(); }30        public Slider AsSlider() { return element.AsSlider(); }31        public Tab AsTab() { return element.AsTab(); }32        public TabItem AsTabItem() { return element.AsTabItem(); }33        public TextBox AsTextBox() { return element.AsTextBox(); }34        public Thumb AsThumb() { return element.AsThumb(); }...

GridHeaderColumnsExecutor.cs

Source:GridHeaderColumnsExecutor.cs

...5    using System.Linq;6    using global::FlaUI.Core.AutomationElements;7    using FlaNium.Desktop.Driver.FlaUI;8    using FlaNium.Desktop.Driver.Common;9    class GridHeaderColumnsExecutor : CommandExecutorBase10    {11        #region Methods12        protected override string DoImpl()13        {14            var registeredKey = this.ExecutedCommand.Parameters["ID"].ToString();15            var element = this.Automator.ElementsRegistry.GetRegisteredElement(registeredKey);16            GridHeader gridHeader = element.FlaUIElement.AsGridHeader();17            var result = gridHeader.Columns;18            var flaUiDriverElementList = result19                .Select<AutomationElement, FlaUIDriverElement>((Func<AutomationElement, FlaUIDriverElement>)(x => new FlaUIDriverElement(x)))20                .ToList<FlaUIDriverElement>();21            var registeredKeys = this.Automator.ElementsRegistry.RegisterElements(flaUiDriverElementList);22            var registeredObjects = registeredKeys.Select(e => new JsonElementContent(e));23            return this.JsonResponse(ResponseStatus.Success, registeredObjects);24        }25        #endregion26    }27}...

GridHeader

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using FlaUI.Core.AutomationElements;7using FlaUI.Core.AutomationElements.Infrastructure;8using FlaUI.Core.Definitions;9using FlaUI.Core.Tools;10using FlaUI.Core.WindowsAPI;11using FlaUI.UIA3;12using System.Windows.Automation;13using System.Windows.Automation.Provider;14{15    {16        static void Main(string[] args)17        {18            var app = FlaUI.Core.Application.Launch(@"C:\Windows\System32\calc.exe");19            using (var automation = new UIA3Automation())20            {21                var window = app.GetMainWindow(automation);22                var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("CalculatorResults")).AsGrid();23                var gridHeader = grid.Header;24                var columnCount = gridHeader.ColumnCount;25                var columnHeaders = gridHeader.ColumnHeaders;26                var columnHeader = gridHeader.GetColumnHeader(0);27                var columnHeader2 = gridHeader.GetColumnHeader("Column 1");28                var columnHeader3 = gridHeader.GetColumnHeaderByAutomationId("ColumnHeader 2");29                var rowCount = gridHeader.RowCount;30                var rowHeaders = gridHeader.RowHeaders;31                var rowHeader = gridHeader.GetRowHeader(0);32                var rowHeader2 = gridHeader.GetRowHeader("Row 1");33                var rowHeader3 = gridHeader.GetRowHeaderByAutomationId("RowHeader 2");34                Console.WriteLine("Press any key to exit");35                Console.ReadKey();36            }37        }38    }39}

GridHeader

Using AI Code Generation

1using FlaUI.Core.AutomationElements;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Text;6using System.Threading.Tasks;7using System.Windows.Automation;8{9    {10        static void Main(string[] args)11        {12            var app = FlaUI.Core.Application.Launch(@"C:\Windows\System32\calc.exe");13            var mainWindow = app.GetMainWindow(FlaUI.Core.Automation.AutomationFactory.Instance);14            var grid = mainWindow.FindFirstDescendant(cf => cf.ByAutomationId("CalculatorResults")).AsGrid();15            var header = grid.Header;16            var headerText = header.Text;17            Console.WriteLine(headerText);18            Console.ReadLine();19        }20    }21}22var header = grid.FindFirstDescendant(cf => cf.ByControlType(ControlType.Separator)).AsSeparator();

GridHeader

Using AI Code Generation

1using FlaUI.Core.AutomationElements;2using FlaUI.Core.Definitions;3using FlaUI.Core.Input;4using FlaUI.Core.WindowsAPI;5using FlaUI.UIA2;6using System;7using System.IO;8using System.Linq;9using System.Reflection;10using System.Threading;11{12    {13        static void Main(string[] args)14        {15            string path = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "Calculator.exe");16            var app = FlaUI.Core.Application.Launch(path);17            var automation = new UIA2Automation();18            Thread.Sleep(2000);19            var window = app.GetMainWindow(automation);20            var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("CalculatorResults")).AsGrid();21            var row = grid.Rows.First();22            var cell = row.Cells.First();23            var header = cell.Header;24            string name = header.Name;25            string automationId = header.AutomationId;26            ControlType controlType = header.ControlType;27            var boundingRectangle = header.BoundingRectangle;28            var parent = header.Parent;29            var children = header.Children;30            var child = header.Children.First();31            var child2 = header.FindFirstChild(cf => cf.ByControlType(ControlType.Custom));32            var child3 = header.FindFirstChild(cf => cf.ByAutomationId("CalculatorResults"));33            var child4 = header.FindFirstChild(cf => cf.ByName("CalculatorResults"));

GridHeader

Using AI Code Generation

1using FlaUI.Core.AutomationElements;2using FlaUI.Core.AutomationElements.Infrastructure;3using FlaUI.Core.Definitions;4using FlaUI.Core.Tools;5using System;6{7    {8        static void Main(string[] args)9        {10            var application = Application.Launch("notepad.exe");11            var automation = application.GetAutomation();12            var mainWindow = application.GetMainWindow(automation);13            var grid = mainWindow.FindFirstDescendant(cf => cf.ByControlType(ControlType.DataGrid)).AsGrid();14            var header = grid.Header;15            foreach (var column in header.Columns)16            {17                Console.WriteLine(column.Name);18            }19        }20    }21}

GridHeader

Using AI Code Generation

1using FlaUI.Core.AutomationElements;2using FlaUI.Core.Definitions;3using FlaUI.Core.Tools;4using System;5using System.Collections.Generic;6using System.Linq;7using System.Text;8using System.Threading.Tasks;9using System.Windows.Automation;10{11    {12        public AutomationElement Header { get; set; }13        public GridHeader(AutomationElement element)14        {15            Header = element;16        }17        public AutomationElement[] GetItems()18        {19            var items = Header.FindAllDescendants(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.HeaderItem));20            var itemsArray = items.ToArray();21            return itemsArray;22        }23        public AutomationElement GetItem(int index)24        {25            var items = Header.FindAllDescendants(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.HeaderItem));26            return items.ToArray()[index];27        }28        public AutomationElement GetItem(string name)29        {30            var items = Header.FindAllDescendants(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.HeaderItem));31            return items.ToArray().Where(x => x.Name == name).FirstOrDefault();32        }33        public void ClickItem(int index)34        {35            var items = Header.FindAllDescendants(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.HeaderItem));36            var item = items.ToArray()[index];37            item.Click();38        }39        public void ClickItem(string name)40        {41            var items = Header.FindAllDescendants(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.HeaderItem));42            var item = items.ToArray().Where(x => x.Name == name).FirstOrDefault();43            item.Click();44        }45    }46}47using FlaUI.Core;48using FlaUI.Core.AutomationElements;49using FlaUI.Core.Definitions;50using FlaUI.Core.Tools;51using System;52using System.Collections.Generic;53using System.Linq;54using System.Text;55using System.Threading.Tasks;56using System.Windows.Automation;57{58    {59        public AutomationElement GridElement { get; set; }60        public Grid(AutomationElement element)61        {62            GridElement = element;63        }64        public GridHeader GetHeader()65        {66            var header = GridElement.FindFirstDescendant(new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Header));67            return new GridHeader(header

GridHeader

Using AI Code Generation

1GridHeader header = window.FindFirstDescendant(cf => cf.ByClassName("DataGridHeader")).AsGridHeader();2headerItem.Select();3headerItem.Select();4headerItem.Select();5headerItem.Select();6headerItem.Select();7headerItem.Select();

GridHeader

Using AI Code Generation

1var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("grid1")).AsGrid();2var header = grid.Header;3var headerList = header.ColumnHeaders;4headerList[0].Click();5headerList[1].Click();6headerList[2].Click();7headerList[3].Click();8var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("grid1")).AsGrid();9var header = grid.Header;10var headerList = header.ColumnHeaders;11headerList[0].Click();12headerList[1].Click();13headerList[2].Click();14headerList[3].Click();15var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("grid1")).AsGrid();16var header = grid.Header;17var headerList = header.ColumnHeaders;18headerList[0].Click();19headerList[1].Click();20headerList[2].Click();21headerList[3].Click();22var grid = window.FindFirstDescendant(cf => cf.ByAutomationId("grid1")).AsGrid();23var header = grid.Header;24var headerList = header.ColumnHeaders;25headerList[0].Click();26headerList[1].Click();27headerList[2].Click();28headerList[3].Click();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.