FormBoss 2 Documentation
Top Link
Sortable Page Image


In Brief: Add an image element to your form. Images can be of any acceptable web type.

Dependencies: none.

Hints & Tricks: To upload an image, click on the 'Upload Image' button. A Flash based * file selector will pop-up, select an image from your drive and click ok.

There is no set image size limit, but be mindful of users who may not have a fast internet connection.

If you set this image as as submit button, you must REMOVE any real submit button elements on your form, or your form will break due to limitations in Javascript.

APACHE UPLOAD ERRORS (uploaded images do not show up)
* There is a known compatibility issue with some Apache Web Servers and mod_security. A simple workaround is available, which you can find here.

Options/Properties

Basic Attributes

Label
The text your button displays.

As of Build 701, this field accepts the standard FormBoss 2 token set for field labels. Please see the in-app tooltip for exact values to use.

As of Build 705, this field now accepts the standard FormBoss 2 token set for Section/Headline Text and Body Copy elements. That is, we used to only be able to use the @{value} token, as can now use F{}, S{} and so on.

The 'new' FormBoss standard tokens will, by default, transform line breaks into HTML br tags. This is very handy when we want to display a text area to a user where such line breaks have been added. This ensures the typed value matches, as closely as possible, the display.

Also in Build 705 is the 'raw' field token: FR{field_name}. This token was created because by default, when we use a F{} token for say, text1, we are actually creating the following code:

<?php if(isset($_SESSION['qs']["{$_SESSION['entry_key']}"]['text1'])) { echo "{$_SESSION['qs']["{$_SESSION['entry_key']}"]['text1']}"; }?>

That is, a full (but inline) PHP block. This makes it impossible to create custom logic in a Body Copy or Section Text block, as the open and close PHP blocks break any such custom code.

Thus, the raw token only places the raw field value into the text data, nothing more. The same text1 item now looks like:

$_SESSION['qs']["{$_SESSION['entry_key']}"]['text1']

That is, no PHP block, and no isset().

Name/Value
This element is set by FormBoss automatically, though it is recommended to change this value if you decide to display Javascript validation messages, as the text of the error is the value of this field. This value is displayed by default if no Label attribute is assigned to the element. For technical users, this element name is in fact the same as the Name/Value html form attribute of this element.

id
By default is assigned the same value as the Name/Value element, though you can change this to a more field specific value. Not necessary for most applications. For technical users, this is the id attribute of the field item.

Wrapper Class Name
Every field element in FormBoss is wrapped in either a LI or DIV element for Sortable or Free Form page types, respectively. When you place a value in this box it becomes the class="" attribute for that wrapper. Because a wrapper encompass both the input element and wrapper, you can use this value to show and hide sections of your form.

Link Properties

A Note on Link Precedence **
If you're only using images as just that, static images, you don't need to worry about this section. If you do want to use the link options, read on!

Because we have several ways to handle images when being used as links, it's important to note that some settings have precedence over others. That is, if we fill out one field this new setting will override a 'lower' one.

At the top of the food chain is Act as Default Submit. If we have this box checked, no matter what we have in any of the other boxes, our image will act as the default submit button for the form page.

Next down the line is Submit Route. A value in this box means when we run the form a click on the image will be treated as a submit route action. This means we override Link Address, but not Act as Default Submit.

Link Address--Finally, if Act as Default Submit is not checked and Submit Route has no value set, the image will act as a link to the address specified.

** In FormBoss Builds 678 and higher the UI has been rearranged to reflect this order of precedence.

Finally, also as of Build 678, we have expanded the image module so that images used on Confirmation or Builder pages now support image links and tokens.

Act as Default Submit
Check this box to have this image act as the submit button for the form. Be aware that you can only have one submit button per form page, so remove any 'Submit' button items already in the form, if present.

Submit Route
By entering a value in this box you're tell FormBoss that when the button is clicked, go to that page after processing the current pages form elements. This is very similar to a regular Submit buttons Route property, only the element being acted on is an image, not a traditional submit button.

This property takes precedence over the Link Address property.

Link Address
If left blank your images are simply that, static images. However, if you place text into this box FormBoss will render the final form with this element as a clickable link. FormBoss automatically removes any border from image links with the border="0" html property.

As of Build 678, this field now supports FormBoss 2 tokens:

F{field} = FIELD Elements (e.g. Form Items)
S{session} = SESSION
P{post} = POST
G{get} = GET
${php} = PHP


Link Title
Fills the html image property 'title=' with the text you specify. Only used if you have supplied a Link Address for this image.

Link Target
Defaults to _self--but we can specify if we want our image links to open in new windows (_blank). Please note this setting only applies to links being set via Link Address. It has no effect for Submit Route or Act as Default Submit because those types of links are routed through internal mechanisms not governed by normal page redirection.

IMPORTANT NOTE: if you use the Submit Route feature, you NEED to supply a value to the label and the Name/Value ID fields. If you do not supply a value, the internal FormBoss check for proper form submission will fail.

top