Toggle menu

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

Disables all buttons on the current page that have the specified action. The label and fieldID are optional and can be used to target a specific button.

Arguments

ArgumentTypeDescription
actionNameString, requiredThe name of the action to be disabled. 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 disabled.

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

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

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

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

function( helper ) {
    helper.disableActionButton("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.disableActionButton("NEXT", helper.getFieldID('MYTEMPLATE') + '_' + 'BUTTONIDENTIFIER');
}

Share this page

Facebook icon Twitter icon email icon

Print

print icon