Scripting API

Scripting API

UiElementNavigation

Record in Abyss.Core, from Abyss.Core.

An element of a document that can have focus, and how focus comes to it and goes from it, as its Inspector lists them.

public record UiElementNavigation

Constructors

UiElementNavigation

public UiElementNavigation(int Index, string Name, int Depth, bool First, string Up, string Down, string Left, string Right)

An element of a document that can have focus, and how focus comes to it and goes from it, as its Inspector lists them.

Parameters

  • Index: Where it is among the document's elements.
  • Name: Its name; empty for one with none.
  • Depth: How deep it is under the document's top: zero for the top.
  • First: Whether it has focus first, as its document is shown.
  • Up: The element Up goes to from it, by name; empty where the guess from where elements are drawn decides.
  • Down: The element Down goes to.
  • Left: The element Left goes to.
  • Right: The element Right goes to.

Properties

Index

public int Index { get; init; }

Where it is among the document's elements.

Name

public string Name { get; init; }

Its name; empty for one with none.

Depth

public int Depth { get; init; }

How deep it is under the document's top: zero for the top.

First

public bool First { get; init; }

Whether it has focus first, as its document is shown.

Up

public string Up { get; init; }

The element Up goes to from it, by name; empty where the guess from where elements are drawn decides.

Down

public string Down { get; init; }

The element Down goes to.

Left

public string Left { get; init; }

The element Left goes to.

public string Right { get; init; }

The element Right goes to.

Methods

Toward

public string Toward(UiDirection direction)

The element direction goes to from it, by name; empty for the guess.

Parameters

  • direction