Controls ss:ajax delayedload event region ss:data calendar column repeater table tree ss:forms captcha checkbox codeeditor combobox datepicker daterange dialogbox editbox fileupload fileuploadimage form hidden money officeuseregion option password paymentmethod radiobutton row searchbox selectlist signature slider spinbox submitbutton submitimage submitlink textarea timepicker ss:layout rotator stepper stepperpanel tablist tablistitem ss:logic dependency parse if else include template variable ss:navigation breadcrumbs item primary secondary ss:personalisation firstname fullname lastname other ss:regions content contentadditional security togglable ss:standard audio embed icon image label link script video ss:templates column row section ss:thirdparty googlemap googlemapmarker
.
.
.

<ss:forms:form> </...>

Creates a HTML form with many additional options for handling its submission.

Content

any
Usually contains <ss:forms:row> elements, containing each form item.

Attributes

action
string
The URL the form will submit to. By default, forms submit to the current page and this is the appropriate behaviour most of the time. If another page is specified here, the form will submit (and the client will navigate to) the new page. Submitting to other pages may disrupt Synergy 8's ability to handle the form. Default = "".
contactGroupAdd
string
Add the contact identified by the form submission into 1 or more groups. Contacts can be identified by a name and email address. Multiple groups can be listed seperated by commas (,).
contactGroupRemove
string
Remove the contact identified by the form submission from 1 or more groups. Contacts can be identified by a name and email address. Multiple groups can be listed seperated by commas (,).
contactMode
string
Different ways to handle any Contact database fields included in the form.

Default value = no handling. Possible values:
  • "register" - Registers the contact and fails validation if the contact already exists.
  • "store" - Optionally registers the contact if they do not exist.
  • "guest" - Same as 'store' but creates a New Contact and does not log the current user in.
  • "login" - Logs in the contact (requires contact_email and contact_password fields).
  • "logout" - Logs out the contact.
  • "unsubscribe" - Unsubscribes the contact.
contactPrefill
string
If the current user is logged in, should the form be prefilled with their details. Default = true.
controlSSubmit
bool
If ControlSSubmit is true, the form will submit when Ctrl+S is pressed on the keyboard
dataColumn
string
The data column of the parent form to store the id of the
disableCSRF
bool
Determines if CSRF should be disabled for the current form
encType
string
The form content encoding type

Different encoding types are required for uploading different types of data.

application/x-www-form-urlencoded Form data is encoded as name/value pairs.

multipart/form-data Form data is encoded as a message with a separate part for each control on the page.

text/plain Form data is encoded in plain text, without any control or formatting characters.
height
mixed
Sets the height of the element. The default units are pixels. include the percentage symbol % to user percentage values.
id
string
(Required) Give this control a unique id. Can be accessed in the client DOM (eg, document.getElementById('myid'), or in the server DOM using $myid or $('myid')).
leavePageWarning
bool
If a user modifies the contents of a form and navigates away without saving their changes, should a warning be displayed?
method
string
The form submit method

Set to 'get' to submit form item values through the GET query string Set to 'post' to submit form item values through the POST http headers Set to 'ajax' to submit form item values through an AJAX xhttprequest POST
noRefresh
bool
If no refresh is set to true, the form wont repost when refreshed
onSubmitEmail
string
If set, an email will be sent with the contents of the form to the specified email addresses. For example, a company can nominate an email address for customer feedback, and the Feedback form can email every submission to that address. Multiple address are seperated by commas (,).
onSubmitEmailShowAdminLinks
bool
If true, the email sent to all addresses listed in onsubmitemail will have two links to the Synergy 8 admin Dashboard Open Contact and View Submission. Default = true.
onSubmitEmailSubject
string
The subject of the email that will be sent to all addresses listed in onsubmitemail.
onSubmitRedirect
string
The URL to be redirected to upon successful form submission.
onSuccessToastMessage
string
If set, a green notification containing the message will briefly appear in the top-right hand corner of the page for every client when they successfully submit the form.
recordSubmissions
bool
Whether or not to record submissions to this form. Form submissions are viewable on the Synergy 8 Dashboard, and are also accessible by other system components such as Automation. Generally it's a good idea to enable for any non-trivial forms where users are submitting information, such as for a feedback form. Enabling for simple forms such as login forms and email sign-up forms is not recommended as they will clutter the form submission history for your site. Default = false.
saveState
bool
When set to true, the value of all child form items is persisted when the page is revisited
width
mixed
Sets the width of the element. The default units are pixels. include the percentage symbol % to user percentage values.

Examples

Simple Form Elements

shows how to construct a basic form

XML Code:


Run Example