sgapiSetQuestionRuntimeProperty(%%qID,%%property,%%value)

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language. Visit our NEW Lua Scripting Resources!

Legacy Custom Scripting Language Deprecation Plans 

  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. The exact date on this is to be determined; we will send notifications well ahead of time.

This function sets the specified runtime property for the given question.

Possible Properties Values
Required true/false
Soft-Required true/false
Disabled true/false
Number (This is the question number displayed at runtime) question number e.g. 1.

Example

Below is an example script that demos each property available via the sgapSetQuestionRuntimeProperty function.

Check it out in an Example Survey

%%property = sgapiGetValue(2);
if (%%property == 'Required')
{
  sgapiSetQuestionRuntimeProperty(3,'Required',true);
}
else if (%%property == 'Soft required')
{
  sgapiSetQuestionRuntimeProperty(3,'Soft-Required',true);
}
else if (%%property == 'Disabled')
{
  sgapiSetQuestionRuntimeProperty(3,'Disabled',true);
}
else if (%%property == 'Number')
{
  sgapiSetQuestionRuntimeProperty(3,'Number',"12.");
}