This callback function is called when saving a subpreset with a corresponding preset template. The callback will only be called if the scope of the preset template is set correctly.
- If the MacroPage with the preset template is attached to an element other than the script module (e.g., the program), the scope of the preset template must be set to the script module (e.g., @0:Script Module).
- If the MacroPage with the preset template is attached to the script module itself, the scope does not need to be set.
In addition, you need to define a section for the preset template. When you save a subpreset the section will be passed on from the preset template to the callback. You can manage different subsets of parameters by using the section as condition for an
if statement that stores only the parameters of interest. The
return statement with the data must be the last statement of the callback. The data returned by the callback will be stored in the subpreset. When the subpreset is restored, the onLoadSubPreset callback will receive the stored data. The data can be of any type, but it is common practice to use a table that can easily be extended with more fields.
Scope and section are template parameters. They can be set in the MacroPage Designer on the properties pane of the preset template.
Available in: Controller.
|section||The section as defined in the corresponding preset template.||string|
The returned data will be stored in a subpreset.