ScriptAPI (ArcFlow.Next): Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Steht in der freigegebenen Version noch nicht zur Verfügung.
Keine Bearbeitungszusammenfassung
Zeile 4: Zeile 4:


Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript wird einem Bereich zugewiesen und kann in dem Bereich aufgerufen werden. Die Addons werden über die Schaltfläche [[File:Menubar_addon.png|x24px]] angezeigt und können dort auch aufgerufen werden. Die Zuweisung des Skripts zum Bereich wird unter "Einstellungen / Erweitert / Addons" definiert. Das Skript selbst kann unter "Einstellungen / Erweitert / Skripte" geschrieben werden. Die Einstellungen werden nur bei Benutzern angezeigt, die der Benutzergruppe "Administratoren" angehören.
Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript wird einem Bereich zugewiesen und kann in dem Bereich aufgerufen werden. Die Addons werden über die Schaltfläche [[File:Menubar_addon.png|x24px]] angezeigt und können dort auch aufgerufen werden. Die Zuweisung des Skripts zum Bereich wird unter "Einstellungen / Erweitert / Addons" definiert. Das Skript selbst kann unter "Einstellungen / Erweitert / Skripte" geschrieben werden. Die Einstellungen werden nur bei Benutzern angezeigt, die der Benutzergruppe "Administratoren" angehören.
== Erstellen von Skripten ==
Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.NEXT)|"Einstellungen / Erweitert / Skripte"]] angelegt. Innerhalb des Skripts stehen die Objekte "af" und "treeNode" zur Verfügung, die Zugriff auf die Befehle und Konstanten der Schnittstelle und des Baums auf der linken Seite der Applikation ermöglichen. Die meisten Befehle der Schnittstelle liefern ein Resultat zurück, mit dem der Erfolg des Befehls überprüft werden kann. Je nach Befehl enthält das zurückgegebene Objekt auch das Ergebnis des Befehls. Die Anweisungen des Skripts werden asynchron ausgeführt, wir verwenden daher in dem Beispiel das "then"-Konstrukt.
Beispiel:
<pre class=source>
af.next.AfAbmLstGet(treeNode.id).then(result => {
    alert(result.code);
});
</pre>


Vorgehen beim Schreiben eigener Skripte
Vorgehen beim Schreiben eigener Skripte

Version vom 10. Oktober 2024, 15:03 Uhr

ScriptAPI
Grundlegende Beschreibung zur Erstellung von Skripten
Diese Seite wird zur Zeit bearbeitet. Der Inhalt kann falsch oder zumindest wahnsinnig ungenau sein. Wir sind dabei das zu beheben.

Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript wird einem Bereich zugewiesen und kann in dem Bereich aufgerufen werden. Die Addons werden über die Schaltfläche angezeigt und können dort auch aufgerufen werden. Die Zuweisung des Skripts zum Bereich wird unter "Einstellungen / Erweitert / Addons" definiert. Das Skript selbst kann unter "Einstellungen / Erweitert / Skripte" geschrieben werden. Die Einstellungen werden nur bei Benutzern angezeigt, die der Benutzergruppe "Administratoren" angehören.

Erstellen von Skripten

Um ein neues Skript zu erstellen, wird das Skript zunächst unter "Einstellungen / Erweitert / Skripte" angelegt. Innerhalb des Skripts stehen die Objekte "af" und "treeNode" zur Verfügung, die Zugriff auf die Befehle und Konstanten der Schnittstelle und des Baums auf der linken Seite der Applikation ermöglichen. Die meisten Befehle der Schnittstelle liefern ein Resultat zurück, mit dem der Erfolg des Befehls überprüft werden kann. Je nach Befehl enthält das zurückgegebene Objekt auch das Ergebnis des Befehls. Die Anweisungen des Skripts werden asynchron ausgeführt, wir verwenden daher in dem Beispiel das "then"-Konstrukt.

Beispiel:

af.next.AfAbmLstGet(treeNode.id).then(result => {
    alert(result.code);
});

Vorgehen beim Schreiben eigener Skripte

Zur Verfügung stehende Umgebung Objekt "af" af.next.<Befehl>(<Parameter>) af.next.constant.AFErrOk Zugriff auf die Umgebung treeNode = ausgewähltes Objekt im Arbeitsmappenbaum treeNode.id = Id des Objekts (Arbeitsmappe oder Archivnummer) treeNode.type = "workfolder" im Falle einer Arbeitsmappe af.user Benutzer

Ausgabe mit alert()

Programmierung in einer Umgebung in der Anweisungen parallel ausgeführt werden Verwendung von .then, await, async

Rückgabewert von Anweisungen result.code = Rückgabewert der Funktion result.returnValues.abmList[0].afAbmId bei der Rückgabe einer Liste von Arbeitsmappen