Version 6.3.8 für Windows
 —  Leitfaden zur Programmierung  —

Results Interface

Dieses Dokument behandelt folgende Themen:


Zweck des Results Interfaces

Mit dem Results Interface können Daten im Results-Fenster (Ergebnisfenster) von Natural Studio angezeigt werden. Siehe auch Results-Fenster in der Dokumentation Natural Studio benutzen.

Anmerkung:
Die Ergebnisse der Menübefehle Find Objects und Cat All werden vom Results Interface nicht beeinflusst.

Das Aussehen und die Benutzung einer Registerkarte im Results-Fenster kann mit Hilfe von Programmierschnittstellen (APIs) definiert werden. In der Regel wird eine detaillierte Ansicht mit Spalten und Zeilen benutzt.

Für jeden Eintrag kann ein Kontextmenü erstellt werden. Somit kann ein Eintrag nach der Anzeige einer benutzerdefinierten Registerkarte für weitere Verarbeitungsschritte verwendet werden.

Diese Weiterverarbeitung muss in zwei Programmen definiert werden:

  1. In einem Update-Command-Handler bevor das Kontextmenü angezeigt wird.

  2. In einem Command-Handler, falls ein Eintrag markiert ist.

Die Programmierschnittstellen für das Results Interface sind USR5001N - USR5017N. Sie befinden sich in der Library SYSEXT.

Ein Beispiel der verschiedenen Funktionen finden Sie in USR5001P, wobei der Update-Command-Handler in USR5001A und der Command-Handler in USR5001B zu finden ist.

Anmerkungen:

  1. Mit dem Results Interface ist es nicht möglich, Änderungen an den vordefinierten Registerkarten (zum Beispiel, an den Registerkarten mit den Namen Find Objects und Cat All) vorzunehmen.
  2. Das Results-Fenster und das Results Interface können nur von Natural Studio aus aufgerufen werden.

Seitenanfang

Auf das Results-Fenster zugreifen

Mit der folgenden Programmierschnittstelle können Sie auf das Results-Fenster zugreifen.

API Funktionalität
USR5001N Schaltet das Results-Fenster ein und aus. Überprüft die Sichtbarkeit des Results-Fensters.

Seitenanfang

Registerkarten

Mit den unten aufgeführten Programmierschnittstellen kann das allgemeine Layout einer Registerkarte definiert werden.

Eine Registerkarte kann alles oder nur eines von Folgendem enthalten:

Eine Registerkarte kann mit den folgenden Attributen definiert werden:

API Funktionalität
USR5004N Layout für eine Registerkarte hinzufügen, ersetzen, löschen oder verwalten.
USR5005N Aktive Registerkarte setzen und holen. Aktive Registerkarte festlegen und den Fokus auf diese Registerkarte setzen.

Seitenanfang

Bilder

Mit der folgenden Programmierschnittstelle können Sie Bitmaps (*.bmp) und Icons (*.ico) für eine bereits definierte Registerkarte angeben.

API Funktionalität
USR5002N Auf einer Registerkarte Bitmaps und Icons hinzufügen oder löschen.

Seitenanfang

Kontextmenüs

Mit den folgenden Programmierschnittstellen können Sie benutzerdefinierte Kontextmenüs angeben.

API Funktionalität
USR5003N Auf einer Registerkarte Kontextmenüs hinzufügen, entfernen und löschen.
USR5007N Den Status (markiert/aktiviert) eines Befehls in einem Kontextmenü setzen und holen.

Die Hierarchie des Kontextmenüs muss manuell definiert werden.

Die folgenden Array-Bestandteile können definiert werden:

Array-Bestandteil Wert Beschreibung
Typ 1 bis 4

1 - Kontextmenübearbeitung.
2 - Trennlinie.
3 - Beginn eines Untermenüs.
4 - Ende eines Untermenüs.

Befehlskennzeichen 1 bis 255 Frei wählbare Zahl für einen bestimmten Befehl im Kontextmenü (wird im Command-Handler benutzt).
Bezeichnung Alphanumerischer Text Text für Kontextmenübefehle vom Typ 1 und 3. Ein Text für die Statusleiste kann mit "H'0'A" abgegrenzt werden.
Bild Image-Handle Handle für ein bereits definiertes Bild (Bitmap oder Icon). Das Bild wird vor dem Text für den Kontextmenübefehl platziert.

Seitenanfang

Befehle

Ein Programm kann als Update-Command-Handler oder als Command-Handler zugewiesen werden.

Benutzerdaten können im internen Arbeitsbereich des Command-Handlers gespeichert oder wieder hergestellt werden.

Beispiel: Handles für Registerkarten.

Die folgenden Programmierschnittstellen stehen zur Verfügung:

API Funktionalität
USR5006N Update-Command-Handler und Command-Handler definieren.
USR5016N Daten für den Command-Handler-Arbeitsbereich setzen und holen.

Seitenanfang

Spalten

Mit den folgenden Programmierschnittstellen kann das allgemeine Spalten-Layout definiert werden.

Eine Spalte kann alles oder nur eines von Folgendem enthalten:

Außerdem können die Standardbreite und die angegebene Breite einer Spalte individual gesetzt werden.

API Funktionalität
USR5008N Auf einer Registerkarte Spalten hinzufügen, einfügen und löschen.
USR5009N Anzahl der Spalten zählen.
USR5010N Standardspaltenbreite und Breite der angegebenen Spalten setzen und holen.

Seitenanfang

Zeilen

Mit den folgenden Programmierschnittstellen können die Zeilen definiert werden, die Bilder und Kontextmenüs enthalten.

API Funktionalität
USR5009N Anzahl der Zeilen zählen.
USR5011N Auf einer Registerkarte Zeilen hinzufügen, einfügen und löschen.
USR5015N Eine Zeile kann in den sichtbaren Bereich des Result-Fensters gerollt werden.

Seitenanfang

Daten

Mit den folgenden Programmierschnittstellen können Benutzerdaten in definierte Spalten/Zeilen geschrieben werden.

Wenn auf einer Registerkarte Kontrollkästchen definiert wurden, können sie in jeder Zeile aktiviert/deaktiviert werden.

API Funktionalität
USR5012N Daten für eine Registerkarte setzen und holen.
USR5013N Aktivierungsstatus einer Zeile setzen und holen.

Seitenanfang

Markierungen

Mit den folgenden Programmierschnittstellen können Zeilen individuell markiert werden.

API Funktionalität
USR5014N
  • Markierte Zeilen setzen, zurücksetzen und holen.

  • Anzahl der markierten Zeilen zählen.

  • Zeilenmarkierung setzen und zurücksetzen.

USR5015N Zeile mit dem Fokus setzen und holen.
USR5017N Markierte Zeilen in die Zwischenablage kopieren.

Seitenanfang