{ "$schema": "../../TcHmiFramework/Schema/ControlDescription.Schema.json", "apiVersion": 1, "name": "TcHmiRecipeEdit", "namespace": "TcHmi.Controls.Beckhoff", "displayName": "Recipe Edit", "version": { "full": "14.4.1.0", "major": 14, "minor": 4, "build": 1, "revision": 0 }, "visible": true, "themeable": "Standard", "base": "TcHmi.Controls.System.TcHmiControl", "description": "A control to edit recipes at runtime", "defaultDesignerEvent": "", "properties": { "containerControl": false, "geometry": { "width": 650, "height": 400 } }, "icons": [ { "name": "Icons/16x16.png", "width": 16, "height": 16 } ], "template": "Template.html", "dependencyFiles": [ { "name": "Style.css", "type": "Stylesheet", "description": "" }, { "name": "../dist/TcHmiRecipeEdit/TcHmiRecipeEdit.esm.js", "type": "EsModule", "description": "Contains all the main logic as ES module." } ], "themes": { "Base": { "resources": [ { "name": "Themes/Base/Style.css", "type": "Stylesheet", "description": "" } ] }, "Base-Dark": { "resources": [ { "name": "Themes/Base-Dark/Style.css", "type": "Stylesheet", "description": "" } ] } }, "attributes": [ { "name": "data-tchmi-server-domain", "propertyName": "ServerDomain", "propertySetterName": "setServerDomain", "propertyGetterName": "getServerDomain", "displayName": "Server Domain", "visible": true, "displayPriority": 100, "type": "tchmi:general#/definitions/String", "category": "Common", "themeable": "Advanced", "description": "The domain of the recipe management extension in the server. Defaults to 'TcHmiRecipeManagement'.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "TcHmiRecipeManagement" }, { "name": "data-tchmi-path", "propertyName": "Path", "propertySetterName": "setPath", "propertyGetterName": "getPath", "displayName": "Path", "visible": true, "displayPriority": 11, "type": "tchmi:general#/definitions/String", "category": "Common", "themeable": "Advanced", "description": "The current path.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": "" }, { "name": "data-tchmi-allowed-recipe-types", "propertyName": "AllowedRecipeTypes", "propertySetterName": "setAllowedRecipeTypes", "propertyGetterName": "getAllowedRecipeTypes", "displayName": "Allowed Recipe Types", "visible": true, "displayPriority": 12, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiRecipeEdit.NameArray", "category": "Common", "themeable": "Advanced", "description": "Which recipe types are allowed. Recipes that are based on other types are hidden.\nIf not set, or set to an empty array, recipes of all types will be shown.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "allowSymbolExpressionsInObject": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-preselected-recipe-type", "propertyName": "PreselectedRecipeType", "propertySetterName": "setPreselectedRecipeType", "propertyGetterName": "getPreselectedRecipeType", "displayName": "Preselected Recipe Type", "visible": true, "displayPriority": 13, "type": "tchmi:general#/definitions/String", "category": "Common", "themeable": "Advanced", "description": "Can be used to preselect a recipe type when creating a new recipe.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": null }, { "name": "data-tchmi-selected-items", "propertyName": "SelectedItems", "propertyGetterName": "getSelectedItems", "displayName": "Selected Items", "visible": true, "type": "tchmi:framework#/definitions/TcHmi.Controls.Beckhoff.TcHmiRecipeEdit.NameArray", "category": "Common", "description": "An array containing the names of the currently selected items.", "readOnly": true, "bindable": false, "defaultBindingMode": "OneWay", "heritable": true }, { "name": "data-tchmi-prompt-before-activating", "propertyName": "PromptBeforeActivating", "propertySetterName": "setPromptBeforeActivating", "propertyGetterName": "getPromptBeforeActivating", "displayName": "Prompt Before Activating", "visible": true, "displayPriority": 15, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "themeable": "Advanced", "description": "Whether to display a popup asking the user for confirmation before activating a recipe.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false }, { "name": "data-tchmi-prompt-before-teaching", "propertyName": "PromptBeforeTeaching", "propertySetterName": "setPromptBeforeTeaching", "propertyGetterName": "getPromptBeforeTeaching", "displayName": "Prompt Before Teaching", "visible": true, "displayPriority": 16, "type": "tchmi:general#/definitions/Boolean", "category": "Common", "themeable": "Advanced", "description": "Whether to display a popup asking the user for confirmation before teaching a recipe.", "readOnly": false, "bindable": true, "defaultBindingMode": "OneWay", "heritable": true, "defaultValue": null, "defaultValueInternal": false } ], "attributeCategories": [], "functions": [], "events": [ { "name": ".onSelectionChanged", "displayName": ".onSelectionChanged", "visible": true, "displayPriority": 6, "category": "Operator", "description": "The onSelectionChanged event is fired when one or more items are selected or deselected.", "heritable": true, "arguments": [] }, { "name": ".onEditStarted", "displayName": ".onEditStarted", "visible": true, "displayPriority": 7, "category": "Operator", "description": "The onEditStarted event is fired when a recipe is openend to be edited.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeEditRecipeEventObject", "description": "The event object containing information about the recipe." } ] }, { "name": ".onEditEnded", "displayName": ".onEditEnded", "visible": true, "displayPriority": 7, "category": "Operator", "description": "The onEditEnded event is fired when the recipe being edited is closed.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeEditRecipeEventObject", "description": "The event object containing information about the recipe." } ] }, { "name": ".onRecipeActivated", "displayName": ".onRecipeActivated", "visible": true, "displayPriority": 8, "category": "Operator", "description": "The onRecipeActivated event is fired when the recipe being edited is activated.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeEditRecipeNameEventObject", "description": "The event object containing information about the recipe name." } ] }, { "name": ".onRecipeCreated", "displayName": ".onRecipeCreated", "visible": true, "displayPriority": 8, "category": "Operator", "description": "The onRecipeCreated event is fired when a new recipe is created.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeEditRecipeEventObject", "description": "The event object containing information about the recipe." } ] }, { "name": ".onRecipeModified", "displayName": ".onRecipeModified", "visible": true, "displayPriority": 8, "category": "Operator", "description": "The onRecipeModified event is fired when the recipe being edited is saved.", "heritable": true, "arguments": [ { "type": "tchmi:framework#/definitions/TcHmiRecipeEditRecipeEventObject", "description": "The event object containing information about the recipe." } ] } ], "access": [ { "name": "create", "displayName": "Create", "description": "Controls the ability to create recipes and folders. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "rename", "displayName": "Rename", "description": "Controls the ability to rename recipes and folders. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "delete", "displayName": "Delete", "description": "Controls the ability to delete recipes and folders. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "cut", "displayName": "Cut", "description": "Internal access right used for the cut button.", "visible": false, "defaultValueInternal": true, "dependsOn": [ "delete", "create" ] }, { "name": "editRecipe", "displayName": "Edit Recipe", "description": "Controls the ability to manually edit the selected recipe. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "activateRecipe", "displayName": "Activate Recipe", "description": "Controls the ability to activate the selected recipe. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate" ] }, { "name": "teachRecipe", "displayName": "Teach Recipe", "description": "Controls the ability to teach the selected recipe. This defaults to true.", "visible": true, "defaultValueInternal": true, "dependsOn": [ "operate", "editRecipe" ] } ], "dataTypes": [ { "schema": "Schema/Types.Schema.json" } ], "languages": { "en": "Lang/Language.en.json", "de": "Lang/Language.de.json" } }