Page tree
Skip to end of metadata
Go to start of metadata

onLoadSubPreset(section, data)

Description

This callback function is called when loading a subpreset with a corresponding Preset Browser template. The callback will only be called if the scope of the Preset Browser template is set correctly.

  • If the MacroPage with the Preset Browser template is attached to an element other than the script module (e.g., the program), the scope must be set to the script module (e.g., @0:Script Module).
  • If the MacroPage with the Preset Browser template is attached to the script module, the scope does not need to be set.

In adition, the Preset Browser Custom template allows you to define a section for the subpreset. When you load a subpreset, the defined section and the data stored in the subpreset will be passed on to the callback. The data is the same data that was returned by onSaveSubPreset when the subpreset was saved. You can manage different subsets of parameters by using the section as condition for an if statement that restores only the parameters of interest.

Scope and section are template parameters. You can set them in the MacroPage Designer on the properties pane of the Preset Browser and Preset Browser Custom templates.

 

Available in: Controller.

Arguments

sectionThe section as defined in the Preset Browser Custom template.string
dataThe data that was returned by onSaveSubPreset. 

Example

See Also: onSaveSubPreset

2 Comments

  1. Reminder: Please link this page to the documentation of the preset template, once it is available.