buttonTag()

Signature

buttonTag() — returns string

Available in: controller Category: General Form Functions

Description

Builds and returns a string containing a button form control.

Parameters

Name	Type	Required	Default	Description
content	string	no	Save changes	Content to display inside the button.
type	string	no	submit	The type for the button: button, reset, or submit.
value	string	no	save	The value of the button when submitted.
image	string	no	—	File name of the image file to use in the button form control.
prepend	string	no	—	String to prepend to the form control. Useful to wrap the form control with HTML tags.
append	string	no	—	String to append to the form control. Useful to wrap the form control with HTML tags.
encode	any	no	true	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.

Examples

// 1. Basic submit button inside a form
#startFormTag(action="create")#
    #buttonTag(content="Save changes", value="save")#
#endFormTag()#
<!--- Produces: <button type="submit" value="save">Save changes</button> --->

// 2. Reset button to clear form fields
#buttonTag(content="Clear form", type="reset")#
<!--- Produces: <button type="reset" value="save">Clear form</button> --->

// 3. Plain button (no form submission) with a CSS class and id
#buttonTag(content="Open dialog", type="button", value="open", class="btn btn-secondary", id="openDialogBtn")#
<!--- Produces: <button type="button" value="open" class="btn btn-secondary" id="openDialogBtn">Open dialog</button> --->

// 4. Submit button wrapped in a paragraph using prepend and append
#buttonTag(content="Submit", value="submit", prepend="<p>", append="</p>")#
<!--- Produces: <p><button type="submit" value="submit">Submit</button></p> --->

// 5. Image button (renders an img tag inside the button element)
#buttonTag(content="", image="submit-icon.png", value="save")#
<!--- Produces: <button type="submit" value="save"><img src="/images/submit-icon.png" alt="Submit Icon" /></button> --->