update_form_screen

Required. The id (sid) of the form screen to update.

Optional. A new name for the screen.

Optional. Left unchanged if omitted. A short name for this screen, unique across every screen in the system. Spaces and hyphens become underscores, anything else that is not a letter, number or underscore is stripped, and capitals are lowered. If the name you ask for is already in use by another screen, it is adjusted until it is unique. Changing it breaks anything that refers to the screen by the old handle.

Optional. Left unchanged if omitted. When anonymous visitors can reach this screen, require them to enter a passcode that they will have received prior, in order to open a particular entry. On by default. Turning it off means anyone with the link can open the entry, so only do it for truly public access situations. The Anonymous Users group (group 3) will also need permission for the form, use the set_form_permissions tool to do that.

Optional. Make this the default form screen. When a menu item or URL leads to the form without naming a screen, and the user is limited to only interacting with a single entry in the form, Formulize will default to showing this screen. The default form screen is also used by most list screens when users click on entries to display or edit them. Setting true replaces whatever form screen held the position before - a form only has one default form screen at a time. If you are updating, setting false will remove the default ‘.form.’ screen, but only if this screen is currently the one holding it; on any other screen false does nothing, so it cannot displace a different screen by accident.

Optional. A list of targeted page changes. Only include the pages you want to modify or add - pages you do not mention are left unchanged. Target an existing page with a page_number to modify its settings (ie: add_elements, remove_elements, change its title, etc). Omit the page_number to append a new page. To change the order of pages, use the change_form_screen_page_order tool instead.

Optional. Show page-navigation tabs across the top of the form, one per page. Default is true. On an exceptionally long form with many pages, or a form where jumping to an arbitrary page is not desired, you may want to set this to false.

Optional. Show the page-navigation buttons at the bottom of the form. Default is false. On an exceptionally long form with many pages, or a form where jumping to an arbitrary page is not required, you may want to set this to true. This setting controls only the previous and next navigation buttons. It does NOT affect the Save button or the Close button, both of which always appear at the bottom of the form regardless of this setting; to hide the Save button or the Close button, set their label to an empty string via button_text.

Optional. Show a ‘page X of Y’ indicator. Default is false.

Optional. Show a drop-down menu for jumping directly to a page. Default is false.

Optional. Show each page title as a heading at the top of the page. Default is false. If navigation tabs are turned off, this is the only way for the user to see the page titles.

Optional. Lay out each page in one or two columns. In two-column layout the element captions go in column one and the inputs in column two, collapsing to one column on phones. Default is 2.

Optional. CSS width of the first column (eg ‘20%’, ‘200px’, ‘auto’). In a one-column layout this is the width of the whole form and defaults to ‘auto’. In a two-column layout it defaults to ‘20%’.

Optional. CSS width of the second column in a two-column layout. Default is ‘auto’.

Optional. Custom labels for the form buttons. Only include the ones you want to change; the rest keep their existing/default labels. Hide buttons by setting an empty string as the value.

Button to save and go back to the previous page. This is one of the page-navigation buttons, so it only appears when show_navigation_buttons is true. Default is “Save and Go Back”.

Button to save and go on to the next page. This is one of the page-navigation buttons, so it only appears when show_navigation_buttons is true. Default is “Save and Continue”.

Button to save without changing page or closing. Always shown at the bottom of the form (regardless of show_navigation_buttons) if the user can save; set to an empty string to hide it. Default is “Save”.

Button to close the screen without saving. Always shown at the bottom of the form (regardless of show_navigation_buttons); set to an empty string to hide it. Default is “Close”.

When show_navigation_buttons is true, this is the previous_page label when on the first page, and clicking it will save and close the form. When show_navigation_tabs is true, this text is used for a special leftmost tab which the user can click to save and close the form. Default is “Save and Close”.

When show_navigation_buttons is true, this is the next_page label when on the last page. Used to save and finish (which will either close the screen, or take the user to the Thanks page if show_thanks_page is true). Default is “Save and Finish”.

Button to open the printable version of the form. Default is “Printable Version”.

Text of the link on the Thanks page that leaves the form. Default is “Leave this form and continue browsing the site”.

Optional. When false (default), finishing the form is treated as done and no Thanks page is shown. When true, a Thanks page is shown after the user finishes.

Optional. The message shown to the user on the Thanks page after they finish the form (only used when show_thanks_page is true). May contain HTML markup.