cp.ui.Cell.md

docs » cp.ui.Cell

---

Represents an AXCell axuielement.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Fields - Variables which can only be accessed from an object returned by a constructor
• childrenUI
• columnIndexRange
• rowIndexRange
• selected
• value
• Methods - API calls which can only be made on an object returned by a constructor
• textValueIs

API Documentation

Functions

matches

Signature	cp.ui.Cell.matches(element) -> boolean
Type	Function
Description	Checks if the element is an AXCell.

Fields

childrenUI

Signature	cp.ui.Cell.childrenUI <cp.prop: table of axuielement; read-only>
Type	Field
Description	The list of axuielements which are children of this Cell.

columnIndexRange

Signature	cp.ui.Cell.columnIndexRange <cp.prop: table; read-only>
Type	Field
Description	Returns a table of {len,loc}, which indicates if the cell covers multiple columns.

rowIndexRange

Signature	cp.ui.Cell.rowIndexRange <cp.prop: table; read-only>
Type	Field
Description	Returns a table of {len,loc}, which indicates if the cell covers multiple rows.

selected

Signature	cp.ui.Cell.selected <cp.prop: table>
Type	Field
Description	Indicates if the cell is currently selected.

value

Signature	cp.ui.Cell.value <cp.prop: string>
Type	Field
Description	The cell value, if it is a string.

Methods

textValueIs

Signature	cp.ui.Cell.textValueIs(value) -> boolean
Type	Method
Description	Checks if the cell's text value equals value.
Parameters	value - The text value to compare.
Returns	true if the cell text value equals the provided value.