ViewHelper Documentation


Form view helper. Generates a


= Basic usage =

Use <f:form> to output an HTML tag which is targeted at the specified action, in the current controller and package. It will submit the form data via a POST request. If you want to change this, use method="get" as an argument. <f:form action="...">...</f:form>

= A complex form with a specified encoding type =

<f:form action=".." controller="..." package="..." enctype="multipart/form-data">...</f:form>

= A Form which should render a domain object =

<f:form action="..." name="customer" object="{customer}"> <f:form.hidden property="id" /> <f:form.textbox property="name" /> </f:form> This automatically inserts the value of {} inside the textbox and adjusts the name of the textbox accordingly.


additionalAttributes anySimpleType, required

Additional tag attributes. They will be added directly to the resulting HTML tag.

data anySimpleType, required

Additional data-* attributes. They will each be added with a "data-" prefix.

action string, required

Target action

arguments anySimpleType, required


controller string, required

Target controller

extensionName string, required

Target Extension Name (without "tx_" prefix and no underscores). If NULL the current extension name is used

pluginName string, required

Target plugin. If empty, the current plugin name is used

pageUid anySimpleType, required

Target page uid

object anySimpleType, required

Object to use for the form. Use in conjunction with the "property" attribute on the sub tags

pageType anySimpleType, required

Target page type

noCache anySimpleType, required

set this to disable caching for the target page. You should not need this.

noCacheHash anySimpleType, required

set this to suppress the cHash query parameter created by TypoLink. You should not need this.

section string, required

The anchor to be added to the action URI (only active if $actionUri is not set)

format string, required

The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)

additionalParams anySimpleType, required

additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)

absolute anySimpleType, required

If set, an absolute action URI is rendered (only active if $actionUri is not set)

addQueryString anySimpleType, required

If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)

argumentsToBeExcludedFromQueryString anySimpleType, required

arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set

addQueryStringMethod string, required

Method to use when keeping query parameters (GET or POST, only active if $actionUri is not set

fieldNamePrefix string, required

Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin

actionUri string, required

can be used to overwrite the "action" attribute of the form tag

objectName string, required

name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName

hiddenFieldClassName string, required


enctype string, required

MIME type with which the form is submitted

method string, required

Transfer type (GET or POST)

name string, required

Name of form

onreset string, required

JavaScript: On reset of the form

onsubmit string, required

JavaScript: On submit of the form

target string, required

Target attribute of the form

novalidate anySimpleType, required

Indicate that the form is not to be validated on submit.

class string, required

CSS class(es) for this element

dir string, required

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id string, required

Unique (in this file) identifier for this HTML element.

lang string, required

Language for this element. Use short names specified in RFC 1766

style string, required

Individual CSS styles for this element

title string, required

Tooltip text of element

accesskey string, required

Keyboard shortcut to access this element

tabindex integer, required

Specifies the tab order of this element

onclick string, required

JavaScript evaluated for the onclick event

ViewHelper Resources

Schema Resources