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
Argument | Type | Description |
---|---|---|
actionName | String, required | The name of the action buttons to hide. Actions are described in the override function section of the Wizard Buttons article |
label | String, optional | The button label to match |
fieldID | String, optional | The 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 Button Helper 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');
}