StockSharp DesktopDriver

What became of an input already sent, by the action identifier its receipt carried. Worth asking when a send failed on the way back and it is not clear whether it happened.

Connects to an application somebody else started with --ui-automation. Needs the endpoint file it wrote. The local channel is restricted to the current OS user. An application attached to this way is never closed by ui_release_application.

Brings a part of a control onto the screen so that it can be clicked - a row far down a table, a tab scrolled off the strip. A grid builds visuals only for what it is showing, so a row a thousand down has nothing to click until this has run. Afterwards look the part up again by its key: everything on screen has moved. This uses the control's own positioning and sends no input, so it proves nothing about whether scrolling works.

The points of one series, as they were drawn. A period or a starting point narrows the answer, which matters on a chart holding thousands of candles. Times are UTC.

The series a chart is drawing: what each is, which area it is in, how many points it holds and what it is drawn with. Read this first — the series identifiers it answers with are what names a series to ui_chart_points.

Clicks a node, or a part of one: a column header, a cell, a panel's tab or its close button. Answers with a receipt saying what became of the click. It being delivered does not mean the application did what was hoped — check that with ui_snapshot or ui_wait.

What the automation module itself has recorded — refusals, things it could not read, input it could not deliver — newest last, with a cursor to carry on from. Worth reading when a tool answered something surprising and the reason is not in the answer.

The connections a diagram routed between its blocks: which socket of which block each leaves and reaches, and the polyline it was actually drawn as. Name a block to read only what touches it. A connection the composition holds but nothing drew has no route, and says so.

The blocks a diagram drew: what each is, what its caption reads as, whether it is selected and where it was drawn. The keys it answers with are what names a block to ui_diagram_connections.

How a workspace is arranged: its panels, the tab groups they sit in, which one of each is on top, what is floating and how the space is divided. A panel's address from here is what the reading tools take.

The lines of a document, numbered from one. ui_snapshot on the same node gives the language, the line and character counts, where the caret is, how much is selected and anything the editor is complaining about. The text is what the editor is showing, not what was bound into it: an editor that was given text and failed to show it reads as empty here, which is the point.

Finds nodes by what they are or what they are called. At least one of the conditions has to be given; they all have to match. Answers with addresses to pass to the reading and driving tools. Kinds are words such as grid, chart, orderBook, propertyEditor, workspace, button, textBox.

The columns of a table: what each is called, whether it is on show, how wide it is and how it is sorted. Read this first — the column identifiers it answers with are what names a cell.

The groups a table is grouped into, with the count and the aggregates of each, and whether it is open. Naming a group answers with the groups inside it.

The rows of a table, as the table itself has them after sorting, filtering and grouping. viewData reads what the table holds; viewport reads only the rows drawn on screen right now. Naming rows or columns narrows the answer, which matters: a wide table is a lot of cells.

Lists the applications this machine can drive and the ones already running. Start here: every other tool names an application by the instance reported in runningAs. An application that is not built cannot be started; it has to be built with the driver in it, which is usually a separate build.

The levels an order book is showing, keyed by side and price, as bid@100.5 or ask@100.7. Naming a side answers with only that half. ui_snapshot on the same node gives the best prices, the spread, the totals per side and whether the book is crossed.

Presses one key at a node, optionally with modifiers. Keys are named as Avalonia names them: Enter, Escape, Tab, Delete, Back, Up, Down, Left, Right, Home, End, PageUp, PageDown, F1 to F12, A to Z, D0 to D9.

The properties a property editor is showing, each by its path on the object, with its value, the text on screen, what kind of editor it calls for, and anything the editor is refusing. A property nobody has opened has no properties of its own yet: opening one is something a person does, and a read will not do it.

Lets go of an application. One this server started is closed; one it only attached to is left running, because closing it would close a window its owner is working in.

Takes a picture of a node and writes it to a file, answering with the file's path and the picture's details. Use ui_screenshot_image when the picture itself is needed rather than the file. To check what a control holds, read it instead — a picture cannot be compared reliably.

Takes a picture of a node and answers with the image itself, to be looked at. The whole image travels back, so aim it at the control in question rather than at a whole window. A size limit refuses an oversized picture rather than shrinking it: a shrunk picture cannot be measured.

Scrolls a node. Distances are in wheel notches; negative scrolls down and right.

What an instance is and what it can do: the product and its version, the fixture it was started with, whether the outside world has been replaced, how input is sent and the default read budget.

Everything one node has to say about itself: whether it is there, enabled, visible and focused, where it is, and the state its own kind defines — a grid's counts and sort, a chart's ranges, a book's best prices. Use this to check what a click actually did.

Starts one of the applications from ui_list_applications and waits until its window is drawn and it can be driven. Answers with the instance to pass to every other tool. Starting the same application twice gives two instances, and the second is named with a #2.

The tree of nodes under one node, or under the whole application when no node is given. Bounded by depth and count; the answer says when it was cut short. Reading never changes what it reads: it does not open a panel that has never been shown or expand a property that is closed.

The items a tree is showing, each by its path, with its text and whether it is open and selected. An item nobody has opened has nothing inside it yet: opening one is something a person does, and a read will not do it. Name a parent to read only what is directly inside it.

Types text into a node. Append adds to what is there; Replace clears it first. The text is typed as characters, so the application's own input handling runs exactly as it would for a person.

Waits until a node satisfies a condition, or until the time runs out. Either that the node is there or is not, or that one of the fields ui_snapshot reports compares as asked. The field is named by its path in that answer, such as rowCount or bestBidPrice. Say which kind the value is: guessing between a price and a label gets it wrong silently and the wait simply times out.

The windows and popups an application has open, each with the address of its root node. Use this to find out where to look before searching inside.