DownloadRecipeTypes
function DownloadRecipeTypes(ctx: TcHmi.SelectableRequired<TcHmi.Context<void>, 'success' | 'error'>, filter: string[] | null, referencedRecipeTypes = false): void
Die Funktion DownloadRecipeTypes lädt die angegebenen Rezepttypen als Datei herunter. Diese Funktion muss durch eine direkte Nutzerinteraktion, bspw. ein Klick auf einen Button, ausgelöst werden, um erfolgreich zu sein.
Parameter
|
Name |
Typ |
Beschreibung |
|---|---|---|
ctx | Kontext Objekt Muss bei der Verwendung in einem Trigger oder einem Funktionsausdruck nicht vom Anwender angegeben werden. Die Übergabe und die Auswertung erfolgt in diesem Fall über den entsprechenden Parser. Wird vom Aufrufer verwendet, um dem Framework bei der Ausführung Erfolg oder Fehlschlag zu signalisieren. Bei direkter Verwendung der Funktion in JavaScript/TypeScript muss das Kontext-Objekt beim Aufruf übergeben und ggf. ausgewertet werden. | |
filter | Gibt an, welche Rezepte heruntergeladen werden sollen. Der Wert null kann verwendet werden, um alle Rezepte herunterzuladen, oder es kann ein Array verwendet werden, welches die Pfade der herunterzuladenden Rezepte enthält.
Beispiel: ['Recipe1', 'Folder::SubFolder::Recipe2'] | |
referencedRecipeTypes | Kann gesetzt werden, um alle in den herunterzuladenden Rezepten referenzierten Rezepttypen mit herunterzuladen. |
Rückgabewert
Typ | Beschreibung |
|---|---|
void | Kein Rückgabewert. |
NuGet-Paket: Beckhoff.TwinCAT.HMI.Functions
 | Verfügbar ab Version 1.12.758 |