sgapiHidePage(%%pageID,true/false)

Important Update to Custom Scripting

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


  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 hides or shows a page.

Example

In this example script we hide pages 3 and 4 by default by setting sgapiHidePage for these page IDs to true. Then, based on the answer to the jedi or sith question on page one we set the sgapiHidePage to false thus showing the appropriate page, jedi or sith.

Check it out in an Example Survey

// HIDE PAGES
sgapiHidePage(3,true);
sgapiHidePage(4,true);

// GET THE VALUE OF THE QUESTION TO CONDITIONALLY SHOW THE PAGE
%%jediorsith = sgapiGetValue(2);

// DETERMINE WHICH OPTION IS SELECTED AND SET THE PAGEID ATTRIBUTE TO SHOW THE APPROPRIATE PAGE
if (%%jediorsith == 'jedi'){
  %%pageid = '3';
} else {
  %%pageid = '4';
}
    
// SHOW THE APPROPRIATE PAGE 
sgapiHidePage(%%pageid,false);