Toggle menu

helper.hideActionButton(actionName [,label] [,fieldID])

Ensures that all buttons on the current page that perform the specified action are hidden.

The label and fieldID are optional and will restrict the button being targeted.

Executed

Client-side only.

Arguments

ArgumentTypeDescription
actionNameString, requiredThe name of the action buttons to hide. Actions are described in the override function section of the Wizard Buttons article
labelString, optionalThe button label to match
fieldIDString, optionalThe ID of the field to target

Example

In this example all FINISH (submit) actions will be hidden.

function(helper) {
    helper.hideActionButton("FINISH");
}

In this example only the FINISH button with the label "Submit" will be hidden.

function(helper) {
    helper.hideActionButton("FINISH", "Submit");
}

In this example only the FINISH button of FIELD4 will be hidden.

function(helper) {
    helper.hideActionButton("FINISH", helper.getFieldID("FIELD4"));
}

This function works with a button generated by the Navigation Buttons Handlebars helper. Note how the button's identifier is used to find it within the template.

function(helper) {
    helper.hideActionButton("NEXT", helper.getFieldID('MYTEMPLATE') + '_' + 'BUTTONIDENTIFIER');
}

Last modified on 13 September 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon