Skip to content

Grid

flaui.core.automation_elements.Grid

Bases: AutomationElement

Element for grids and tables

column_count property

Gets the total column count.

Returns:

Type Description
int

Column Count

column_headers property

Gets all column header elements.

Returns:

Type Description
List[AutomationElement]

List of column header elements

header property

Gets the header item.

Returns:

Type Description
GridHeader

Header item

row_count property

Gets the total row count.

Returns:

Type Description
int

Row Count

row_headers property

Gets all row header elements.

Returns:

Type Description
List[AutomationElement]

List of row header elements

row_or_column_major property

Gets whether the data should be read primarily by row or by column.

Returns:

Type Description
RowOrColumnMajor

Row/Column

rows property

Returns the rows which are currently visible to UIA. Might not be the full list (eg. in virtualized lists)! /// Use "GetRowByIndex" to make sure to get the correct row.

Returns:

Type Description
List[GridRow]

List of GridRow elements

selected_item property

Gets the first selected item or null otherwise.

Returns:

Type Description
GridRow

GridRow element if selected, else None

selected_items property

Gets all selected items.

Returns:

Type Description
List[GridRow]

List of GridRow elements

add_to_selection(row_index=None, column_index=None, text_to_find=None) 

add_to_selection(
    row_index: int,
    column_index: None = None,
    text_to_find: None = None,
) -> "GridRow"

add_to_selection(
    row_index: None = None,
    column_index: int = ...,
    text_to_find: str = ...,
) -> "GridRow"

Add a row to the selection by index or by text in the given column.

Parameters:

Name Type Description Default
row_index Optional[int]

Row index

 None
column_index Optional[int]

Column index

 None
text_to_find Optional[str]

Text to find in the column

 None

Returns:

Type Description
GridRow

GridRow element

Raises:

Type Description
ValueError

On invalid input combination
Source code in flaui/core/automation_elements.py 
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
@handle_csharp_exceptions
def add_to_selection(
    self, row_index: Optional[int] = None, column_index: Optional[int] = None, text_to_find: Optional[str] = None
) -> GridRow:
    """Add a row to the selection by index or by text in the given column.

    :param row_index: Row index
    :param column_index: Column index
    :param text_to_find: Text to find in the column
    :raises ValueError: On invalid input combination
    :return: GridRow element
    """
    if all([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.AddToSelection(column_index, text_to_find),
                "Row not found in column, cannot add to selection",
            )
        )
    elif all([row_index]) and not any([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.AddToSelection(row_index),
                "Row not found in row index, cannot add to selection",
            )
        )
    else:
        raise ValueError("Invalid input sent to the function, cannot add to the selection")

get_row_by_index(row_index)

a row by index.

Parameters:

Name Type Description Default
row_index int

Row index

 required

Returns:

Type Description
GridRow

GridRow element
Source code in flaui/core/automation_elements.py 
1972
1973
1974
1975
1976
1977
1978
1979
@handle_csharp_exceptions
def get_row_by_index(self, row_index: int) -> GridRow:
    """a row by index.

    :param row_index: Row index
    :return: GridRow element
    """
    return GridRow(raw_element=self.raw_element.GetRowByIndex(row_index))

get_row_by_value(column_index, value)

Get a row by text in the given column.

Parameters:

Name Type Description Default
column_index int

Column index

 required
value str

Value

 required

Returns:

Type Description
GridRow

GridRow element
Source code in flaui/core/automation_elements.py 
1981
1982
1983
1984
1985
1986
1987
1988
1989
@handle_csharp_exceptions
def get_row_by_value(self, column_index: int, value: str) -> GridRow:
    """Get a row by text in the given column.

    :param column_index: Column index
    :param value: Value
    :return: GridRow element
    """
    return GridRow(raw_element=self.raw_element.GetRowByValue(column_index, value))

get_rows_by_value(column_index, value, max_items=0)

Get all rows where the value of the given column matches the given value.

Parameters:

Name Type Description Default
column_index int

The column index to check.

 required
value str

The value to check.

 required
max_items int

Maximum numbers of items to return, 0 for all, defaults to 0

 0

Returns:

Type Description
List[GridRow]

List of found rows as GridRow elements.
Source code in flaui/core/automation_elements.py 
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
@handle_csharp_exceptions
def get_rows_by_value(self, column_index: int, value: str, max_items: int = 0) -> List[GridRow]:
    """Get all rows where the value of the given column matches the given value.

    :param column_index: The column index to check.
    :param value: The value to check.
    :param max_items: Maximum numbers of items to return, 0 for all, defaults to 0
    :return: List of found rows as GridRow elements.
    """
    return [GridRow(raw_element=_) for _ in self.raw_element.GetRowsByValue(column_index, value, max_items)]  # type: ignore

remove_from_selection(row_index=None, column_index=None, text_to_find=None) 

remove_from_selection(
    row_index: int,
    column_index: None = None,
    text_to_find: None = None,
) -> "GridRow"

remove_from_selection(
    row_index: None = None,
    column_index: int = ...,
    text_to_find: str = ...,
) -> "GridRow"

Remove a row to the selection by index or by text in the given column.

Parameters:

Name Type Description Default
row_index Optional[int]

Row index

 None
column_index Optional[int]

Column index

 None
text_to_find Optional[str]

Text to find in the column

 None

Returns:

Type Description
GridRow

GridRow element

Raises:

Type Description
ValueError

On invalid input combination
Source code in flaui/core/automation_elements.py 
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
@handle_csharp_exceptions
def remove_from_selection(
    self, row_index: Optional[int] = None, column_index: Optional[int] = None, text_to_find: Optional[str] = None
) -> GridRow:
    """Remove a row to the selection by index or by text in the given column.

    :param row_index: Row index
    :param column_index: Column index
    :param text_to_find: Text to find in the column
    :raises ValueError: On invalid input combination
    :return: GridRow element
    """
    if all([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.RemoveFromSelection(column_index, text_to_find),
                "Row not found in column, cannot remove from selection",
            )
        )
    elif all([row_index]) and not any([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.RemoveFromSelection(row_index),
                "Row not found in row index, cannot remove from selection",
            )
        )
    else:
        raise ValueError("Invalid input sent to the function, cannot remove from the selection")

select(row_index=None, column_index=None, text_to_find=None) 

select(
    row_index: int,
    column_index: None = None,
    text_to_find: None = None,
) -> "GridRow"

select(
    row_index: None = None,
    column_index: int = ...,
    text_to_find: str = ...,
) -> "GridRow"

Select the first row by text in the given Row index or a combination of Column index along with text_to_find.

Parameters:

Name Type Description Default
row_index Optional[int]

Row index

 None
column_index Optional[int]

Column index

 None
text_to_find Optional[str]

Text to find in the column

 None

Returns:

Type Description
GridRow

GridRow element

Raises:

Type Description
ValueError

On invalid input combination
Source code in flaui/core/automation_elements.py 
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
@handle_csharp_exceptions
def select(
    self, row_index: Optional[int] = None, column_index: Optional[int] = None, text_to_find: Optional[str] = None
) -> GridRow:
    """Select the first row by text in the given Row index or a combination of Column index along with text_to_find.

    :param row_index: Row index
    :param column_index: Column index
    :param text_to_find: Text to find in the column
    :raises ValueError: On invalid input combination
    :return: GridRow element
    """
    if all([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.Select(column_index, text_to_find), "Row not found in column"
            )
        )
    elif all([row_index]) and not any([column_index, text_to_find]):
        return GridRow(
            raw_element=self._retry_while_null_reference_exception(
                lambda: self.raw_element.Select(row_index), "Row not found in row index"
            )
        )

    else:
        raise ValueError("Invalid input sent to the function, cannot select the row")