$ Functions: System - Recipes

The following $ functions let you configure WebPage User Inputs to manipulate recipes when the vision system is Online. For example, you can use these functions in an On Clicked script point of a Button element to let you check, load, save or remove existing recipes from the job while the device is Online.

$System.Recipes.RecipeName.Contains(configurationName : String) : Boolean
Returns	Boolean, returning true if the recipe configuration is found.
Arguments	configurationName: String, specifying the name of the recipe configuration whose presence is checked.
Description	Checks if the recipe (specified with RecipeName) has the specified recipe configuration.

$System.Recipes.RecipeName.Load(configurationName : String)
Returns	N/A
Arguments	configurationName: String, specifying the name of the recipe configuration to load.
Description	Loads the specified recipe configuration to the job.

$System.Recipes.RecipeName.Save(configurationName, description : String)
Returns	N/A
Arguments	configurationName: String, specifying the name of the recipe configuration to save. description: String, specifying the description of the configuration to save.
Description	Saves the specified recipe configuration from the job, along with a description. Note: If a configuration with the same name already exists, execution of this function overwrites that existing configuration.

$System.Recipes.RecipeName.Remove(configurationName : String)
Returns	N/A
Arguments	configurationName: String, specifying the name of the recipe configuration to remove.
Description	Removes the specified recipe configuration from the job, and deletes its values.