UI-Automatisierungs-APIs

Mit APIs können Sie auf die Dienste zugreifen und mit ihnen interagieren, die im Menü Pakete verwalten angeboten werden. Sie können diese APIs verwenden, wenn Sie codierte Automatisierungen entwerfen. Unter Codierte Automatisierungen erfahren Sie mehr über codierte Automatisierungen und wie sie mit APIs gestaltet werden können.

Hinweis: Mit Zu Definition wechseln (F12) können Sie auf die Definition von UiPath-APIs für einen bestimmten Dienst zugreifen. Es wird empfohlen, sich beim Implementieren codierter Automatisierungen nur auf die direkt verfügbar gemachten APIs zu verlassen. Andere APIs, die nicht direkt mit einem Dienst verknüpft sind, können ohne vorherige Ankündigung geändert werden.

Überladungen

APIs enthalten oft Überladungen, was bedeutet, dass sie mehrere Versionen der gleichen Methode mit unterschiedlichen Parameteroptionen bereitstellen. Mit Überladungen können Sie das Verhalten der API basierend auf Ihren spezifischen Anforderungen anpassen. Beispielsweise kann eine UI-Automatisierungs-API eine Überladung enthalten, die einen Timeout-Parameter akzeptiert, um die maximale Zeit anzugeben, die gewartet werden soll, bis ein UI-Element angezeigt wird, bevor die Ausführung beendet wird.

Durch die Verwendung der APIs mit ihren jeweiligen Überladungen können Sie ganz einfach die gewünschte Automatisierungslogik und das gewünschte Verhalten erreichen.

UI-Automatisierungs-APIs

Dieser Abschnitt enthält die APIs, die im Dienst UiPath.UIAutomationNext.API.Contracts zu finden sind.

API	Beschreibung
Anhängen	Konzentriert sich auf eine bereits geöffnete Desktop-Anwendung oder Webbrowser-Seite, um sie in der UI-Automatisierung zu verwenden.
Prüfen (Check)	Aktiviert oder deaktiviert ein Kontrollkästchen oder ein Optionsfeld.
Klicken (Click)	Klickt auf ein angegebenes UI-Element, z. B. auf eine Schaltfläche oder einen Link. Sie können die Klickaktion je nach Anwendungsfall weiter konfigurieren.
ClosePopup	Schließt alle Popups ab, die sich über der Anwendung befinden.
Ziehen und Ablegen	Führt einen Drag-and-drop-Vorgang vom Quell-UI-Element zum Ziel-UI-Element aus.
Daten extrahieren	Extrahiert Daten als Datentabelle.
Attribut erhalten (Get Attribute)	Ruft den Wert eines festgelegten Attributs des angegebenen UI-Elements ab.
GetChildren	Ruft die untergeordneten Elemente eines angegebenen Ziels ab.
GetRuntimeTarget	Ruft das Laufzeitziel eines angegebenen Ziels ab.
GetText	Extrahiert und kopiert den Text aus einem UI-Element.
Get URL	Ruft die URL von der aktuellen Webseite ab.
GoToUrl	Navigiert im angegebenen Webbrowser zur angegebenen URL.
Markieren (Highlight)	Hebt ein bestimmtes UI-Element visuell hervor, indem es einen Rahmen erhält.
Darauf zeigen (Hover)	Ruft die URL von der aktuellen Webseite ab.
IsEnabled	Überprüft, ob ein UI-Element aktiviert ist.
Tastaturkürzel (Keyboard Shortcut)	Sendet eine oder mehrere Tastenkombinationen an ein UI-Element.
Mouse Scroll	Ermöglicht das Scrollen in Anwendungen durch Senden von Maus-Scroll-Ereignissen an das angegebene UI-Element.
Offen	Öffnet eine Desktopanwendung oder eine Webbrowserseite zur Verwendung in der UI-Automatisierung.
Objekt auswählen (Select Item)	Wählt ein Element aus einem Dropdown-Kombinationsfeld oder Listenfeld aus.
SetRuntimeBrowser	Legt den derzeit aktiven Runtime-Browser fest.
SetValue	Legt einen Wert für ein beliebiges Eingabefeld fest: Eingabefeld, Dropdown, Kontrollkästchen, Optionsfeld.
Screenshot anfertigen (Take Screenshot)	Erstellt einen Screenshot eines angegebenen UI-Elements oder einer angegebenen Anwendung und speichert ihn als Datei.
Eingeben in (Type Into)	Gibt Text in ein bestimmtes UI-Element ein, z. B. ein Textfeld. Sie können auch Sondertasten wie die Tabulator- oder die Eingabetaste an das UI-Element senden.
Wartestatus	Prüft den Status einer Anwendung oder eines Webbrowsers, indem überprüft wird, ob ein Element auf der Benutzeroberfläche angezeigt wird oder nicht angezeigt wird.

Verwenden von UI-Automatisierungs-APIs

Sie können UI-Automatisierungs-APIs in Kombination mit UI-Elementen verwenden. Bei der Automatisierung von UI-Anwendungen wird die gewünschte Anwendung geöffnet oder in den Mittelpunkt gerückt, dann werden die entsprechenden UI-Elemente automatisiert. Führen Sie die folgenden Schritte aus, um eine Anwendung mithilfe von UI-Automatisierungs-APIs zu automatisieren:

1. Rufen Sie den UIAutomation-Dienst auf, wenn Sie die Attach- und Open -APIs verwenden. Diese APIs werden allein verwendet, um eine Anwendung oder einen Webbrowser zu öffnen oder darauf zu fokussieren.
   1. Wenn Sie mit UI-Elementen arbeiten, die im Objekt-Repository als Deskriptoren erfasst wurden, verwenden Sie die Open- oder Attach-API mit der Überladung IScreenDescriptor:

      uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)

   2. Kopieren Sie bei nativen Selektoren das <app/>-Tag der Anwendung mit dem UI-Explorer und verwenden Sie die Open-API mit der TargetAppModel-Überladung:

      var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"))

2. Rufen Sie die UIAutomation-APIs direkt in einem UI-Element auf.
   1. Wenn Sie mit UI-Elementen arbeiten, die im Objekt-Repository als Deskriptoren erfasst wurden, verwenden Sie die restlichen APIs mit der IElementDescriptor-Überladung:

      var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
      applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")

   2. Kopieren Sie bei nativen Selektoren das <webctrl/>-Tag des Elements mit dem UI-Explorer und verwenden Sie die restlichen APIs mit den TargetAnchorableModel-Überladungen:

      var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
      applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")