Toggle menu

helper.getPageMode()

Returns the mode of the page.

Pages have three "modes" - EDIT and REMOVE (there's also "default" which doesn't really count, which will return as null in this function).

Edit mode is used when updates are being made to a page that has already been saved to the session.

Remove mode is used with repeating pages and deletes a page instance.

See Page Modes for more information.

Executed

Client-side and server-side.

Arguments

None. It is only possible to check the mode of the current page.

Returns

If the page is being completed by a user for the first time, or if the page does not repeat, this function will return null.

String. One of:

  • EDIT - A page that has already been submitted is being edited
  • REMOVE - A page instance that has already been submitted is being deleted
Last modified on May 13, 2024

Share this page

Facebook icon Twitter icon email icon

Print

print icon