Wire attributes
Attributes are values that are applied to wire tags. Each wire tag has a different list of available attributes.
You can select attributes for a tag by placing your cursor after the tag, then tapping the space bar. You can use any of the following attributes.
24hour
Returns the hour as a 24 hour digit. The default date (today's date) is read-only.
Value: Integer
accelerated
When the value is set to yes, uses an accelerated rendering mode to display content in a web browser. Defaults to no when not defined.
Accelerated rendering is recommended for full-screen video content, which opens in a browser window in front of other Wire content.
Non-accelerated rendering supports a smaller runtime footprint. It also supports animations within the wire such as rotate and scale, and sorting the order of user interface elements.
Value: yes, no
accept
Defines the content-types that are acceptable.
Example value: "text/plain"
accessoryview
Determines the side of the pin details on which to display an accessory view box when the annotation is selected. Accessories can be other object tags living as children to the annotation tag. (Ex: An image tag can live as an accessory to the annotation and display within the accessory view.)
Value: left, right
Mobile Client for Android only
accessoryviewheight
Determines the height of your accessory view within your annotation.
Value: The height in pixels. This value is capped by iOS at 100px.
accessoryviewwidth
Determines the width of your accessory view within your annotation.
Value: The width in pixels.
action (launch)
Identifies a supported action that the device app selected to launch can perform.
Value: Available actions
action (play)
Defines the action to run when the <play> tag is set.
Value: The tag name of the action you want to run.
action (sound)
Determines the action of the sounds to play or stop.
Value: play, stop, record
Note:Recorded audio will be in ACC format.
album
Determines the name of the album where photos taken will be stored. Defaults to Camera Roll. If the album defined here does not exist, the system will create it as needed.
Value: Alphanumeric characters
alias
Assigns a global value that can take the place of a traditional target path. Every alias must have a value that is globally unique. It is considered good practice to identify an alias in all CAPS.
Value: Alphanumeric characters
align
Defines the horizontal alignment of an object.
Value: left, right, center
alignment
Defines the horizontal alignment of the text within the field.
Value: left, right, center
allowalternatingrowcolor
When the value is set to yes, you can set alternating row colors.
Value: yes, no
allowcolumnreorder
When the value is set to yes, a user can adjust the order of columns.
Value: yes, no
allowcolumnresizing
When the value is set to yes, a user can resize column width.
Value: yes, no
allowediting
Determines whether the column is editable.
Value: yes, no
allowfiltering
When the value is set to yes, a user can filter column data.
Value: yes, no
allowpaging
When the value is set to yes, you can limit the number of rows that appear on a page.
Value: yes, no
allowmultipleselection
When the value is set to yes, a user can select multiple rows in a <datagrid>.
Value: yes, no
allowrowinsert
When the value is set to yes, a user can add new rows to the grid.
Value: yes, no
allowselection
When the value is set to yes, a user can select cells or rows.
Value: yes, no
allowsorting
When the value is set to yes, a user can sort column data.
Value: yes, no
allowunsort
When the value is set to yes, a user can unsort column data.
Value: yes, no
alpha
Defines the transparency level for the object.
Value: Numeric value between 0.0 and 1.0
alternatingrowcolor
Determines the background color of alternating rows.
Value: Alphanumeric hex value
alternatingrowfontcolor
Determines the font color of alternating rows.
Value: Alphanumeric hex value
altsource
Defines an alternate pivot image when the status of an image changes based on in-Wire settings.
Value: The image file stored within the wire. The value must include the file extension.
ampm
Returns a string for a.m. or p.m. The default date (today's date) is read-only.
Value: Integer
animated
Determines the page animation. When yes is selected, all pages leading to a location are animated. When no is selected, pages will jump to the location without animation. When blank is selected, pages will only animate when within five pages of the target.
Value: yes, no, blank
animateddrop
When yes is selected, animates the dropping of the pin or replacement image. Defaults to no when not defined.
Value: yes, no
app (launch)
Identifies a supported device app that is installed on the user's device.
If the scanner app is used on an Android device, the Zxing scanner app must be previously installed.
Value: Twitter or scanner
Not supported for Mobile Client for Windows PC or Mobile Client for HTML5.
app (opentab)
Specifies an app to run in a new tab in Mobile Client for HTML5. If no app is specified, or the specified app doesn't exist, the current app opens. The specified app must be published in the same promotion level and environment as the current app.
Value: The ID of the app you want to run.
asctext
Determines the text next to the header cell when a row is sorted by ascending order.
Value: String
asset
Loads an image taken from the current device's internal asset library. This is accessed through the use of any camera or photo related <datasource>.
Value: The image file stored within the device, or a parameter to call the value from a datasource object tag.
assetthumb
Loads a thumbnail version of an image taken from the current device's internal asset library.
Value: The image file stored within the device, or a parameter to call the value from a datasource object tag.
attachment
The file name of content stored on the Wire that can be attached to the email when an email form is generated. Requires a mimetype to be defined.
Value: Name of the file stored on the wire including the extension.
authenticate
Authenticate currently only applies to images using URLs from a SalesForce datasource. Will request from the authenticated datasource defined.
Value: Integer
autocorrect
Defines whether iOS native autocorrect applies to the textfield.
Value: yes, no
autohide
Allows notifications to dismiss themselves without being closed by the user. Defaults to no when not defined.
Mobile Client for HTML5 only
Value: yes, no
axis
Defines the axis of the rotate action. Rotate will action on a z axis by default. For Mobile Client for Windows PC, only the z axis applies.
Value: x, y, z
axisfontbold
Specifies the axis font on a chart is bolded.
Value: yes, no
axisfontcolor
Specifies a color for the axis font on a chart.
Value: Alphanumeric hex value
axisfontfamily
Specifies the font applied to the axis text displayed in a chart. Font family is specific to the device platform.
Value: Name of font type. Fonts are limited to the iOS font set.
axisfontitalic
Specifies the axis font on a chart is italicized.
Value: yes, no
axisfontsize
Specifies the size of the axis font displayed in a chart. Font size is specific to the device platform.
Value: Numeric
axisfontunderline
Specifies the axis font on a chart is underlined.
Value: yes, no
background
Determines the background color of the object.
Value: Alphanumeric hex value
base64source
Provides the base64 encoded string content for an image. This is useful when image content is included in SOAP or JSON responses and need to be included in an image tag. When assigning this property, the geometry of the region will not change, thus if new images are displayed via this property they should be of the same geometry as the previous image. The new image will appear immediately after the assign is executed.
Value: A string containing the base64 encoded content of a valid image file.
bcc
Represents the blind carbon copy address of the action-generated email form.
Value: Alphanumeric characters
body
Represents the body copy of the action-generated email form.
Value: Alphanumeric characters. To create a paragraph break within the body copy, enter "\n\n".
border
Creates a border around the input field.
Value: {none}, line, bezel, round
bordercolor
Defines the color of an object's border. Must be used in conjunction with the borderwidth attribute.
Value: Alphanumeric hex value
borderwidth
Defines the width of an object's border. Must be used in conjunction with the bordercolor attribute.
Value: Numeric values set in either pixels or percentages
bottomof
Represents the name of an object that your object will be placed directly below.
Value: Tag name for the preferred object
bounces
Determines if the area will "rubber-band" when the user scrolls to the top or bottom, or if a sudden stop will occur. Will also "snap" scrollable areas that are larger than the viewports.
Value: yes, no
Mobile Client for iOS only
buttononeaction
Defines the action to invoke when the alert's left button is selected.
Value: Tag name of the action
buttononetitle
Allows the user to define the title of the left button within the dialog box.
Value: Alphanumeric characters
buttontwoaction
Defines the action to invoke when the alert's right button is selected.
Value: Tag name of the action
buttontwotitle
Allows the user to define the title of the right button within the dialog box.
Value: Alphanumeric characters
categoryaxistitle
Specifies the name of the x-axis of a chart.
Value: Alphanumeric characters
categorylabel
Specifies a label for a data element in a chart.
Value: Alphanumeric characters
categorysequence
Specifies the grouping of the data elements on the x-axis of a chart.
Value: Alphanumeric characters
cc
Represents the carbon copy address of the action-generated email form.
Value: Alphanumeric characters
cellpadding
Defines the padding within a table cell.
Value: Numeric value
cellwidth
Defines the width of a table cell. The default value is auto.
Value: auto, wrap, numeric value
characterlimit
Defines the character limit for a textfield.
Value: Numeric value
charttype
Defines the type of chart to display.
Value: area, column, line, pie, stacked column
class
Defines the name of the class to be used as a blueprint for the object that will reside in the target location.
Value: The name of an existing class within the wire.
clickdelay
Defines the time delay between the touch down and touch up on an object. Must be used in coordination with an onclick attribute. The onclick action will not trigger until the down state meets the clickdelay value.
Value: Define a numeric value in seconds. The value accepts decimals (ex: .25).
clicktarget
Defines the targeted object on which to perform the defined onclick action assigned.
Value: Tag name or alias of the object
clickuptarget
Defines the targeted object on which to perform the defined onclickup action assigned.
Value: Tag name or alias of the object
clip
When set, the object will crop to its bounds.
Value: yes, no
clipboard
Enables clipboard support on the text tag. This will allow the text to be natively selectable for copy and paste actions.
Value: yes, no
color
Determines the color of an object.
Value: Alphanumeric hex value
color (annotation)
Determines the color of the pin. When not set, the system will default pin color to red.
Value: red, blue, green
color1 - color10
Specifies color values for the data series displayed in a chart. You can assign up to 10 colors; the colors will repeat if a chart contains more than 10 data series.
Value: Alphanumeric hex value
columnid
Assigns a unique identifier to a column.
Value: Alphanumeric characters
contain
When yes is selected, the image will not extend beyond the bounds of its parent object if the image is larger. This is useful when leaving width and height undefined, in which case the image will be presented in its original aspect ratio, but will be centered within the parent.
Value: yes, no
content
Defines the text to display in the table caption.
Value: String
contentfontsize
Defines the font size of a table caption.
Value: Numeric value
contentfontstyle
Defines the font style of a table caption.
Value: The font name
contentstarty
Defines the top margin of a table caption.
Value: Numeric value
contenttextcolor
Defines the font color of a table caption.
Value: Alphanumeric hex value
content-type
Specifies the content-type and the character sets that are accepted, separated by a semi-colon.
Example Value: "text/xml; charset=utf-8″, "multipart/form-data"
controls
Defines video control buttons for the video. You can select yes to display a progress bar, pause button, and play button.
Value: yes, no
cornerradius
Defines the curve of an object's corner.
Value: Numeric value in pixels
covertile
Sets the tile attribute specifically for the first page of a PDF. You can select yes to load the cover page on launch.
Value: yes, no
currentpageindex
Determines the page that is displayed.
Value: The number of the page that is currently being displayed.
curve (rotate)
Defines the motion of the action. Defaults to linear.
Value: linear, easein, easeout, easeinout
curve (translate)
Defines the movement of the object.
Value: linear, easeout
dashboardname
The name of the analytics dashboard.
Value: Alphanumeric characters
datakey
Defines the datasource column that will populate a table column.
Value: String
datasource
Defines the datasource that is referenced by an object.
Value: Name of a datasource tag defined within the wire
dataSourceClearSocial
By default this will be set to a value of zero when not defined. To clear out social authorization, you must use an assign action to change this value. When this value is assigned to 1, social auth will be cleared for the datasource defined.
Example:
<assign property="datasource:DATASOURCENAME.dataSourceClearSocial" value="1" />
Value: 1, 0
datasourceerror
Fires a specific action when the datasource errors.
Value: Name of the desired action
datasourceevent
Defines the datasource event that drives the action to trigger.
Value: Any datasource event name. Known events include the following.
-
querycomplete – datasource query completion returned
-
datasourceerror – datasource error returned
-
interactionrequest – requested datasource interaction request
-
locationupdate – datasource event called when location update is triggered by iOS library *
-
regionenter – region enter returned when current device location enters a current region *
-
regionexit – region exit returned when current device location exits a current region ** currently in beta
dataSourceIndex
Defines the query index in a datasource. Requires datasource, datasourcemappingvalue, and datasourcemappingproperty to work.
Value: Value set will be numeric (ex: ="3")
datasourcemappingproperty
Defines the attribute within the current tag to drive off a datasource. Dependent on datasourcemapping value to server as the replacement for the attribute defined here. Requires datasource, dataSourceIndex, and datasourcemappingvalue to work.
Value: Attribute name contained within the same object
datasourcemappingvalue
The value set is the actual replacement to the attribute detailed in datasourcemappingproperty. Requires dataSourceIndex and datasourcemappingproperty to work.
Value: xpath namespace should be "*[local-name()='thumbnail']/@attribute"
datavalue (datagrid)
Indicates the unique identifier for a row.
Value: String
datavalue (dropdown, dropdownitem)
The value that is returned after a user selects an item from a dropdown.
Value: String
date
Returns the system default date format for the currently displayed date in the datepicker. Uses the natural language processor. Read and write capabilities.
You must use the following format: yyyy-MM-dd HH:mm:ss.SSS (HH is 24-hour time)
Value: Integer
day
Returns the day as an integer. The default date (today's date) is read-only.
Value: Integer
decode
When set to yes, any special characters placed within the text attribute will be removed.
Value: yes, no
degrees
Defines the degree of a rotation limit.
Value: Defined in numerics - accepts negative or positive values
delay
Delays the action from committing.
Value: Numeric value in seconds - value accepts decimals (Ex: .25)
desctext
Determines whether sorted text is descending.
Value: String
developerkey
Defines the YouTube API developer key (retrieve from Google APIs console).
Value: API key for your app
device
All <platform> tags require the developer to define the device definition. When using multiple device types, you will need to use a group name such as "ios" or separate individual device types using a vertical bar "|". The device definition you enter must match the devices selected in App Settings > Platform Selection. For more information, refer to Select platforms and views for an app.
devicerotatetarget
Defines the targeted object on which to perform the defined ondevicerotate action assigned.
Value: Tag name or alias of the object
distanceFilter
Used with a location datasource. Defines the maximum distance covered before a datasourceevent is sent to the language.
Value: Numeric - represents distance in meters - a value of '0' maps to low accuracy and any non-zero value maps to high-accuracy.
draggable
When the value is set to yes, the object can be freely dragged across the screen.
Value: yes, no
draggingtarget
Value defines the target object on which to perform an action, when an object's drag state is enabled.
Value: Tag name or alias of the object
dragorientation
Defines an object's ability to drag on a plane.
Value: horizontal, vertical
dropdownimage
Defines the image that displays on the right side of a dropdown button.
Value: Filename of the image
Mobile Client for HTML5 only
droptarget
Defines the target object on which to perform an action, when an object's drop state is enabled.
Value: Tag name or alias of the object
editingbackground
Determines the background color of a cell that a user is editing.
Value: Alphanumeric hex value
editingbordercolor
Determines the border color of a cell that a user is editing.
Value: Alphanumeric hex value
editingcolor
Determines the font color of a cell that a user is editing.
Value: Alphanumeric hex value
enabled
Determines whether a user can interact with the associated object. Additionally, if the object is disabled, event attributes such as onclickup are also disabled. The default value is yes.
This attribute is supported in the following tags.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
image
-
list
-
map
-
pager
-
panel
-
pdf
-
richtext
-
tableview
-
text
-
textfield
-
video
-
wait
-
web
-
youtube
Note:If this attribute is applied a tag that is not listed above, the attribute is ignored.
Value: yes, no
enablefullscreen
Displays fullscreen option button for the video. Defaults to true.
Value: true, false
encoding
Used to encode the value of an assign tab.
Value: Supported encoding types include: URL, HTML, Base64, SQLite
endcap
Value set will represent the end of a text tag that is limited by maxlength. Requires a maxlength attribute to be set.
Value: Alphanumeric characters
epoch
Returns the number of seconds since January 1, 1970 as an integer. The default date (today's date) is read-only.
Value: Integer
eventduration
Only applies to providertype="location" (gps). Defines the minimum amount of seconds the datasource will throw a querycomplete event in the case of GPS location movement.
Value: Integer
exitalerttext
Allows for defining the text to display in the alert dialog when the exitontabchange runs.
Value: Alphanumeric characters
Mobile Client for HTML5 only
exitontabchange
Exits the running wire app if the wire's browser tab is hidden by another browser tab. Always alerts with text and allows the user to cancel the exit action.
Value: yes, no. Defaults to no
Mobile Client for HTML5 only
external
Alerts the wire that the file/URL should be launched in an available external app on the device. When used, the device will provide a default option, and then allow the user to select from an available list of 3rd party options.
Value: yes, no. Defaults to no
face
Instructs the device on which camera to use when the camera tag is loaded.
Value: front, back
feedback
When set to yes, the web tag will show a wait spinner each time a new page is loaded.
Value: yes, no. Defaults to no
fieldcolor
Defines the background color of the textfield.
Value: Alphanumeric hex value
fieldtype
Determines what fields are used from a datasource, their type, and the retrieval method.
Value: Cell, row
file
Loads the content of a file stored within the Wire, rather than an online source.
Note:The <web> object can accept HTML documents, Microsoft documents, images, PDF files, and any other format that the Safari web browser supports.
Value: Name of the file stored within the Wire
filename
Represents the name to use to store the downloaded file.
Value: Alphanumeric characters
fillcolor
Defines the background color of a table cell.
Value: Alphanumeric hex value
filterable
Allows a user to filter a specific column.
Value: yes, no
firstascending
Determines whether the default sort order is ascending.
Value: yes, no
fitheight
Allows the object to conform to the exact height of all its children combined.
Value: yes, no
fitwidth
Allows the object to conform to the exact width of all its children combined.
Value: yes, no
focusnext
Defines the textfield to focus on when the Next button on the keyboard is selected. If this attribute is defined as the current textfield, the keyboard will display a Done button, instead of a Next button.
Value: Name or alias of a textfield in the Wire file
font
Defines a font name to be used to display the associated text.
Value: Name of font type - fonts are limited to the iOS font set
fontsize
Defines the font size of the associated text.
Value: Numeric value
fontstyle
Defines the style to be used to display the associated text. The default value is normal.
Values: normal, bold, italic, bolditalic
force
Sets content to download regardless of it having been downloaded previously - progresstargets can be used in conjunction with the force parameter.
Value: yes, no
from
Sets the completing range of the loop.
Value: Numeric value
fullscreen
Determines whether a video launches in full screen mode.
Value: yes, no
gotfocustarget
Defines the targeted <textfield> on which to perform the defined lostfocus action assigned.
Value: Path to the object that the action will target.
halign
Determines the horizonal alignment of text within a table. The default value is left.
Value: left, right, center
header (pdfcolumn)
Specifies the text to display in the header row of a table column.
Value: String
header (pdfprint)
Specifies the text to display in the header of a PDF.
Value: String
headeralign
Determines the text alignment of the header.
Value: left, right, center
headerbackground
Determines the background color of the header.
Value: Alphanumeric hex value
headerbordercolor
Determines the border color of the header.
Value: Alphanumeric hex value
headerborderwidth
Determines the width of the header border.
Value: Numeric value
headercolor
Determines the text color of the header.
Value: Alphanumeric hex value
headerfont
Determines the font family of the header.
Value: Name of font type
headerfontsize
Determines the font size of the header in a PDF.
Value: Numeric value
headerfontstyle
Determines the font style of the header in a PDF.
Value: Name of font type
headerhorizontalgridlines
When the value is set to yes, horizontal gridlines are enabled in the header.
Value: yes, no
headerhovercolor
Determines the color of a header when it is in hover state.
Value: Alphanumeric hex value
headerleftinset
Determines the left margin of the header.
Value: Numeric value
headerrightinset
Determines the right margin of the header.
Value: Numeric value
headersize
Determines the font size of the header.
Value: Numeric value
headertextcolor
Determines the font color of the header in a PDF.
Value: Alphanumeric hex value
headerverticalgridlines
When the value is set to yes, vertical gridlines are enabled in the header.
Value: yes, no
height
Defines the height of an object. Height=fit does not work when used within a style.
Value: Numeric values set in pixels or percentages
horizontalgridlines
When the value is set to yes, horizontal gridlines are enabled in a datagrid.
Value: yes, no
horizontalgridvisible
Displays a horizontal grid in a chart.
Value: yes, no
hour
Returns the hour as an integer. The default date (today's date) is read-only.
Value: Integer
hoverawaytarget
Defines the action to invoke when a hover state is removed from an object.
Value: Tag name of the action
Mobile Client for iOS only
hoverrowcolor
Determines the background color of a row in hover state.
Value: Alphanumeric hex value
hoverrowfontcolor
Determines the font color of a row in hover state.
Value: Alphanumeric hex value
hovertarget
Defines a target object on which to perform an action, when a hover state is placed over another object.
Value: Tag name or alias of the object
Mobile Client for iOS only
html
Allows a developer to assign a piece of HTML code into the Wire to push additional styling or content from a datasource.
Value: Name of HTML file stored within a datasource, or within the Wire
httpheader
Identifies the httpheader needed to utilize this datasource. Httpheader tags should display above the datasource tags in your Wire.
Value : The name of the httpheader within the Wire
httpmethod
Used to change the request type to a remote server. Defaults to GET.
Value: GET, POST, PUT, DELETE.
ignoretouches
The object which contains this attribute will ignore all touches.
Value: yes, no
image
Determines an image to display.
Value: File name of a stored image
imagebackgroundsize
Specifies the size of a background image. This must be used with the imagesource attribute. The default value is auto.
Value: The width and height of the image in pixels, or any of the following options.
-
auto: Displays the image with no resizing.
-
cover: Stretches the image to completely cover the column. The edges of the image may be clipped.
-
contain: Resizes the image to fill the column without clipping the image.
-
initial: Resets the attribute to its default value.
imageposition
Specifies the position of a background image. This must be used with the imagesource attribute. The default value is left top.
Value: Any of the following options.
-
left
-
right
-
center
-
left top
-
left center
-
left bottom
-
right top
-
right center
-
right bottom
-
center top
-
center center
-
center bottom
imagerepeat
Determines the repeat pattern of a background image. This must be used with the imagesource attribute. The default value is repeat.
Value: Any of the following options.
-
repeat: Repeats the background image horizonally and vertically.
-
repeat-x: Repeats the background image horizonally.
-
repeat-y: Repeats the background image vertically.
-
no-repeat: Displays the background image once with no repeat.
-
space: Repeats the background image enough times to fill the column without clipping the image. The image is distributed evenly with whitespace.
-
round: Repeats the background image enough times to fill the column. The image is resized to fill the column with no whitespace.
imagesource
Specifies the filename of the image you want to use as a background in a <column>.
This attribute is only available from the <attributes> tag. You may not add a background image to a <column> directly.
You can adjust the position and size of this image with the imageposition and imagebackgroundsize attributes. You can also determine the repeat pattern of the image with the imagerepeat attribute.
Value: File name of a stored image
index
Defines the total number of loops to allow before the loop closes.
Value: Defined as a static number or by using a var:index from a variable or datasource
insertrowposition
Determines the position of the row to be inserted.
Value: top, bottom
insertvar
The action variable that stores the inserted data for each column.
Value: String
kbtype
Defines the type of native keyboard to display. When this attribute is not used, the regular keyboard will be used.
Value: Available keyboard types include:
-
default
-
numberpad
-
phonepad
-
emailaddress
-
decimalpad
-
twitter
-
alphabet
-
namephonepad
-
numberandfunctionNot all of these types are supported in Android.
keyboardappearance
Defines the color of the keyboard used for a textfield.
Value: light, dark
Mobile Client for iOS only
labelfontbold
Specifies the label font on a chart is bolded.
Value: yes, no
labelfontcolor
Specifies a color for the label font on a chart.
Value: Alphanumeric hex value
labelfontfamily
Specifies the font applied to the label text displayed in a chart. Font family is specific to the device platform.
Value: Name of font type - fonts are limited to the iOS font set
labelfontitalic
Specifies the label font on a chart is italicized.
Value: yes, no
labelfontsize
Specifies the size of the label font displayed in a chart. Font size is specific to the device platform.
Value: Numeric
labelfontunderline
Specifies the label font on a chart is underlined.
Value: yes, no
lalign
Align an object horizontally when in landscape view.
Value: left, right, center - if this attribute is not present, the wire will honor the align attribute when in landscape
leftinset
Indent text from the left.
Value: Numeric pixel value
leftof
Represents the name of an object that your object will be placed directly to the left of.
Value: Tag name of a preferred object
legendlocation
Specifies the chart legend placement based on the series.
Value: Options are: top, bottom, left, right, and none.
lheight
Defines the height of the object when the device is in landscape view.
Value: Numeric values set in either pixels or percentages
lhs
Represents the left hand side of the condition defined.
Value: Tag name of a preferred object
linecolor
Defines the color of the borders within a table.
Value: yes, no
linewidth
Defines the width of the borders within a table. If the value is set to 0, no border is drawn.
Value: yes, no
links
Value set will enable active links for email addresses and phone numbers.
Value: yes, no
loadcompletetarget
Defines the target object on which to perform an action when a load is completed.
Value: Tag name or alias of the object
location (annotation)
Defines the latitude and longitude coordinates on a map.
Value: latitude and longitude (ex: 38.896611 -94.348204)
location (datasource)
Used with a location datasource. Enables and disables the GPS radio on the device. If this is not managed, the device battery could drain faster.
Value: yes, no
lock
The value is defined by the developer. All <sync> blocks with the same lock value across the entire wire definition will be prevented from running simultaneously. Among other benefits, locks are useful to prevent long running threads of execution from running simultaneously as a result of multiple events firing from a quick succession of user interactions.
Value: Defined by the developer
logout
For SalesForce datasources only. When this value is assigned to 1, SalesForce will logout for the datasource defined. Example: <assign property="datasource:DATASOURCENAME.logout" value="1" />
Value: yes, no
loop
Determines if a video or sync will repeat in a loop.
Value: yes, no
lostfocustarget
Defines the targeted <textfield> on which to perform the defined gotfocus action assigned.
Value: Path to the object that the action will target.
lscale
Determines the size of the images that display within the gallery when in landscape view.
Value: Floating point Value:
-
< 1 shrinks the tiles
-
> 1 enlarges the tiles
lvalign
Align an object vertically when in landscape view.
Value: Top, center, or bottom - if this attribute is not present, the wire will honor the valign attribute when in landscape
lwidth
Defines the width of the object when the device is in landscape view.
Value: Numeric values set in either pixels or percentages
lxpos
Defines the x axis location of the object when the device is in landscape view.
Value: Numeric values set in either pixels or percentages
lypos
Defines the y axis location of the object when the device is in landscape view.
Value: Numeric values set in either pixels or percentages
margin
Defines the space directly surrounding all sides of an object. Margin is defined based on the bounds of the parent. Siblings' defining margins are free-flowing within the parent.
Value: Numeric values set in either pixels or percentages
margin (pdfprint)
Defines the page margin of a PDF.
Value: {top: number, right: number, bottom: number, left: number}
margin-bottom or bottommargin
Defines the space surrounding the bottom of an object.
Value: Numeric values set in either pixels or percentages
margin-left or leftmargin
Defines the space surrounding the left side of an object.
Value: Numeric values set in either pixels or percentages
margin-right or rightmargin
Defines the space surrounding the right side of an object.
Value: Numeric values set in either pixels or percentages
margin-top or topmargin
Defines the space surrounding the top of an object.
Value: Numeric values set in either pixels or percentages
maskimage
Name of the image source that will display below the canvas.
Value: Numeric values set in either pixels or percentages
matte
Represents the color of the blur.
Value: Alphanumeric hex value. Defaults to black (#000000)
maxlength
Sets a maximum length of characters on a text object. Requires an endcap attribute to be set.
Value: Character count limit
maxresolution
Maxresolution will load in the image as if had been placed in the Wire at that size. It will look for which is greater, width or height, and then scale the image so that the real resolution of the loaded images will match. Removes the need for Retina and non-Retina - just put in the highest resolution required, and place a maxres value on images that are not retina.
Value: Integer
maxsize
Determines the max font size of the text when size=fit is used.
Value: Numeric character for maximum font point size desired - when fit is used, the font size will adjust to a size appropriate to display all text in the text attribute up to the maxsize defined
maxwidth
Determines the maximum width on a text object when width="fit" is used.
Value: Percentage or pixel
maxzoom
Pinch zoom scale limits the amount of zoom allowed.
Value: Magnification of zoom in numeric characters (Ex: 3 = 3 times magnification)
mbottom
Defines the bottom margin of a PDF.
Value: Numeric value
message
Allows a user to define the value of the message within the dialog box. This is required for the action to fire.
Value: Alphanumeric characters
message (log)
Allows a user to define the value of the message to send to the debugger console.
Value: Alphanumeric string
mimetype
Required when an attachment is defined. Determines the method of rendering the email form.
Value: Represents a mime type and extension separated by a ‘/' (ex. mimetype="image/jpg") - the mime type chosen must be stored in the wire
minute
Returns the minute as an integer. The default date (today's date) is read-only.
Value: Integer
mincellheight
Defines the minimum height of a table cell.
Value: Numeric value
mincellwidth
Defines the minimum width of a table cell.
Value: Numeric value
mleft
Defines the left margin of a PDF.
Value: Numeric value
month
Returns the month as an integer. The default date (today's date) is read-only.
Value: Integer
monthname
Returns the month name. The default date (today's date) is read-only.
Value: Name of month
mouseentertarget
Defines target to be impacted by 'onmouseenter' action assignment.
Value: Tag name or alias of the object
Mobile Client for Windows PC and Mobile Client for HTML5 only
mouseexittarget
Defines target to be impacted by 'onmouseexit' action assignment.
Value: Tag name or alias of the object
Mobile Client for Windows PC and Mobile Client for HTML5 only
mousemovetarget
Defines target to be impacted by 'onmousemove' action assignment.
Value: Tag name or alias of the object
Mobile Client for Windows PC and Mobile Client for HTML5 only
movetarget
Defines the targeted object on which to perform the defined onmove action assigned.
Value: Tag name or alias of the object
mright
Defines the right margin of a PDF.
Value: Numeric value
mtop
Defines the top margin of a PDF.
Value: Numeric value
name
Text based identifier for the tag.
Value: Alphanumeric characters - no sibling object tags can contain the same value for the name attribute within the wire
name and value of class parameters
Provide the name and values for the [param:] tokens found within the class being used to create the new object. This is required if parameters exist within a class.
Value: Define the name of the parameter as defined in the class and the value that will replace it
norecordstext
Determines the text that displays when there are no records that match a filter.
Value: String
onback
Launches child actions when the Android back button is selected from the device controls.
Value: yes, no
Mobile Client for Android only
oncapture
Defines the action to invoke when a camera image is saved to the device. Type attribute must equal "photo".
Value: Tag name of the action
onchange
Defines the <action> tag to call when the value of the textfield is changed.
Value: Tag name of the action
onclick
Defines the action to launch when the object or object container is selected or tapped.
Value: Tag name of the action
onclickup
Defines the action to launch when an object is selected or tapped and then released.
Value: Tag name of the action
oncomplete
Defines the action to launch when the launched application closes and returns to the wire.
Value: Tag name of the action
ondeselectionchanged
Determines the action taken when an item is deselected. Prior to SP9, this attribute is only available if the allowmultipleselection attribute is set to True. After SP9, this attribute is available regardless of whether multiple selection is enabled.
Value: Tag name of the action
ondevicerotate
Defines the action to invoke when an object receives movement through device rotation.
Value: Tag name of the action
ondeviceshake
Launches child actions when the device is shaken.
Value: yes, no
ondiddrawpage
Defines the action to launch after a PDF is finished drawing.
Value: Tag name of the action
ondragging
Defines the action to invoke when a drag state move is enabled.
Value: Tag name of the action
ondrop
Defines the action to invoke when a drop state is enabled over the object.
Value: Tag name of the action
oneditingfinished
Determines the action taken when editing is finished.
Value: Tag name of the action
onfinish
Invokes an action when the video has completed.
Value: Tag name of the action
ongotfocus
Defines the action to launch when focus is set on a <textfield> tag.
Value: Tag name of the action
onhide
Defines the <action> tag to call when the keyboard is closed from a textfield.
Value: Tag name of the action
onhover
Defines the action to invoke when a hover state is placed over the object.
Value: Tag name of the action
Mobile Client for iOS only
onhoveraway
Defines the action to invoke when a hover state is removed from an object.
Value: Tag name of the action
Mobile Client for iOS only
oninit
Launches child actions when the app is initially launched.
Value: yes, no
oninsertfinished
Determines the action taken when an insert is finished.
Value: Tag name of the action
onloadcomplete
Defines the action to perform when a datasource is loaded.
Value: Tag name of the action
onlostfocus
Defines the action to launch when focus is lost on the <textfield> tag.
Value: Tag name of the action
onmouseenter
Defines action to trigger when a mouse cursor enters the associated objects space.
Value: Tag name of the action
Mobile Client for Windows PC and Mobile Client for HTML5 only
onmouseexit
Defines action to trigger when a mouse cursor leaves the associated objects space.
Value: Tag name of the action
Mobile Client for Windows PC and Mobile Client for HTML5 only
onmousemove
Defines action to trigger when a mouse cursor moves within the associated objects space.
Value: Tag name of the action.
Mobile Client for Windows PC and Mobile Client for HTML5 only
onmove
Defines the action to invoke when an object receives movement through touch.
Value: Tag name of the action
onnotification
Launches child actions when a notification tag is triggered in the system.
Value: yes, no
onpage
Defines the page number on which an object will occur within a defined PDF. The object containing the onpage attribute must live as a child with a <PDF> tab.
Value: Numeric
onpause
Invokes an action when the video has paused via an event.
Value: Tag name of the action
onplacemarkclicked
Will represent an <action> tag within the wire that will be launched when the placemark on the map is selected.
Value: Tag name of the action
onplay
Invokes an action when the video has started.
Value: Tag name of the action
onpull
Defines the action to invoke when a pager or list receives a pull down effect.
Value: Tag name of the action
Mobile Client for iOS only
onquerycomplete
Defines action to perform when a datasource query is complete.
Value: Tag name of the action
onrefresh
If the attribute is present, pulling the table view down from the top will show the native iOS refresh panel and call the onrefresh action defined. Currently Android and iOS5 and below are NOT supported. To close a refresh panel, inside of the action you define for onrefresh, add the following and target your tableview:
<event type="reset"/>
Value: Tag name of the action
onresume
Launches child actions when the app is launched from the background.
Value: yes, no
onreturnkeypressed
Defines the <action> tag to call when the return key is pressed within the input.
Value: Tag name of the action
onsave (camera)
Defines the action to invoke when a video is saved to the device's photo album after the savevideotoalbum event.
Value: Tag name of the action
onsave (datagrid)
Defines the action to take when a change to a datagrid is saved.
Value: Tag name of the action
onscan
Defines the action to invoke when a barcode scan is detected.
Value: Tag name of the action
onscantarget
Defines the targeted object to perform the defined onscan action assigned.
Value: Tag name or alias of the object
onscroll
Defines the action to invoke when a user scrolls horizontally or vertically within a pager. The selected action executes repeatedly as the user continues to scroll.
Value: Tag name of the action
onscrollaway
Defines the action to invoke when a scroll state moves away within an object.
Value: Tag name of the action
onscrollto
Defines the action to invoke when a scroll action stops within an object.
Value: Tag name of the action
onselect
Defines the action to invoke when an annotation is selected.
Value: Tag name of the action
Mobile Client for Android only
onselectionchanged
Determines the action taken when a select is finished.
Value: Tag name of the action
onshow
Defines the <action> tag to call when the keyboard is triggered from a textfield.
Value: Tag name of the action
onstop
Invokes an action to take when an action has completed.
Value: Tag name of the action
onsubroutineexit
Defines the action to invoke when the subroutine exits.
Value: Tag name of the action
onswipedown
Defines the action to invoke when an object is swiped down.
Value: Tag name of the action
onswipeleft
Defines the action to invoke when an object is swiped left.
Value: Tag name of the action
onswiperight
Defines the action to invoke when an object is swiped right.
Value: Tag name of the action
onswipeup
Defines the action to invoke when an object is swiped up.
Value: Tag name of the action
operator
Defines the type of if statement created with lhs and rhs.
Value: The operator value can be one of the following:
-
e or eq: string equals
-
==: numeric equals
-
ne: string not equals
-
!=: numeric not equals
-
gt: greater than
-
gte: greater than or equals
-
lt: less than
-
lte: less than or equals
optionbackgroundcolor
Defines the background color of an item in a dropdown list.
Value: Alphanumeric hex value
Mobile Client for HTML5 only
optioncolor
Defines the text color of an item in a dropdown list.
Value: Alphanumeric hex value
Mobile Client for HTML5 only
optionhovercolor
Defines the background color of an item in a dropdown list when it is in hover state.
Value: Alphanumeric hex value
Mobile Client for HTML5 only
orientation
Defines the direction an object scrolls. The <pdf> object defaults to horizontal.
Value: vertical, horizontal
orientation (pdfprint)
Defines the page orientation of a PDF. The default value is portrait.
Value: landscape, portrait
outputfile
Defines the name of a jpg to create and save to the device based on a camera capture. If folder and file do not exist, they will be created.
Value: Folder and file name including .jpg extension - Ex: outputfile="/test/recentpic.jpg"
overflow
Defines the behavior of text when it is too large to fit in a table cell. The default value is normal.
Value: linebreak, ellipsize, visible, hidden, normal
padding
Defines the space between an object's border, and the content within the border.
Value: Numeric values set in either pixels or percentages
padding-bottom
Defines the space between an object's bottom border, and the content within the object.
Value: Numeric values set in either pixels or percentages
padding-left
Defines the space between an object's left border, and the content within the object.
Value: Numeric values set in either pixels or percentages
padding-right
Defines the space between an object's right border, and the content within the border.
Value: Numeric values set in either pixels or percentages
padding-top
Defines the space between an object's top border, and the content within the object.
Value: Numeric values set in either pixels or percentages
page
Determines the page or object within the object to which the action will navigate.
Value: next, prev, page #
pagebreak
Specifies whether page breaks within a table are avoided when generating a PDF. If set to avoid, page breaks within a table only occur when the table height is greater than the page height. The default value is auto.
Value: auto, avoid, always
pagelinkclass
The pagelinkclass attribute allows for tying the PDF to classes in the <wire> tag. When someone clicks on a page link within a PDF with pagelinkclass set, a class defined in the wire is invoked.
Value: Name of a class defined within the wire
pagelinkscount
Determines the number of visible page links.
Value: Numeric value
pagesize
Determines the maximum number of rows on each page.
Value: Numeric value
pagetofit
Allows the web content that is loaded to shrink and fit within the dimensions defined for the <web> tag.
Value: yes, no
paginate
Enables the pager to either scroll freely, or snap in place for each object within the pager.
Value: yes, no - set to no for free scrolling, or set to yes for snap scrolling when additional movement objects are added
parsenamespace
When there are name spaces within the datasource, a value set to yes will allow the query set on the datasource to be defined without "//*[local-name()". ATOM Feeds will not parse and need to be queried in the full namespace.
Value: yes, no
password
If yes, each character entered by the user will be replaced by a round dot, obscuring the value entered. The value returned via the text property will be the string that was typed.
Value: yes, no
payload
Identifies a JSON string that is returned back to the wire if the user selects the notification alert to launch the Wire. The payload will be available via a system property payload.
Value: JSON string
pencolor
Determines the color of the brush tip when touching the canvas.
Value: Hexcode
pensize
Determines the circumference of the brush tip when touching the canvas.
Value: Numeric characters
pixel
Determines the pixel value within the object to which the action will scroll.
Value: Numeric value within the allotted pixel size of the target object
placeholder (image)
Images sourced with a URL may use the placeholder attribute to define an image to use as the image is loaded into the image object.
Value: The image file stored within the Wire - must include the file extension
placeholder (textfield)
Defines the text which displays prior to user entered text. This text will not display when a user populates the field.
Value: Alphanumeric characters
placeholdercolor
Defines a hex value color for the placeholder text.
Value: Alphanumeric hex value
placemarks
Allows for a URL to specify areas of the map.
Value: Can be set as KML, GeoRSS, or GeoRSS-Simple URL
playing
Determines if the video is playing or not.
Value: yes, no
progressbar
The path or alias to a <progress> object. If a progressbar is defined, and the user has not yet downloaded the content for the <include> object, the download will take place in the background (allowing the user to continue using other parts of the app). The progress of the download will be continually updated as a bar type indicator defined by path in the progresstarget. If a progress target is not defined, the entire interface will be replaced by a progress indicator that does not have to be defined anywhere in the wire. The user will not be allowed to use the app while the download is occurring., and the wire will be automatically loaded in the <include> target object when the download has finished installing.
Value: The path or alias to a <progress> object
progresstarget
The path or alias to a <progress> object. If a progresstarget is defined, and the user has not yet downloaded the content from the URL defined, the download will take place in the background (allowing the user to continue using other parts of the Wire). The progress of the download will be continually updated as a bar type indicator defined by path in the progresstarget. If a progress target is not defined, the entire interface will be replaced by a progress indicator that does not have to be defined anywhere in the Wire. The user will not be allowed to use the Wire while the download is occurring.
Note:This attribute is only applicable for the <load> action if the target is an <include> object.
Value: The path or alias to a <progress> object
property
Identifies the path to the change requested.
Value: The property attribute will require a format of "type:name.property" or "type:path.property". Types supported are: object, var, preferences, datasource, and template.
providertype
Determines the type of datasource used.
Value: Supported feed types include: xml, twitter, json, push, sql, facebook, contacts (address book), camera (photo library), location (GPS location), music (music library), recordset, and library.
providerurl
When a URL requires track back provider information, this URL can be added using this tag (Ex: Disqus)
Value: URL address of web content
pullclass
Defines the functional spec for the pull to refresh area created with an onpull action.
Value: Name of an existing class created within the wire
Mobile Client for iOS only
pullto
Defines the height of the pull area created with an onpull action.
Value: Numeric value set in pixels
Mobile Client for iOS only
quality
Determines the quality of an image. Value = numeric value - can be set to 128, 256, or 512. Defaults to 256
If using blur, represents the quality of the blur vision. The higher the quality, the more likely the object beneath the blur can be seen.
Value: A numeric value ranging from 1 to 100 - 100 is the highest quality of blur available
query
Query defines the namespace used within the source. For XML you can query with XPath. SQL is queried with standard SQL query conventions. In iOS 8 the available folders of images for Camera datasources have changed slightly. A query of "Camera Roll" may not return any photos. Use "All Photos" instead.
Value: Value should represent the name of the portion of the data feed to pull. Use the HTML representations of the greater and less than symbols when they apply to your XPath syntax. Ex. //*[local-name()='item']
querycomplete
Fires a specific action when a datasource query is complete.
Value: Name of the desired action
querycompletetarget
Defines the target object on which to perform an action when a query is complete for a datasource.
Value: Tag name or alias of the object
radius
Defines the amount of blur placed on the object.
Value: A numeric value starting at 1 - the higher the number, the more blur occurs
refreshtarget
Defines the targeted object to perform the defined onrefresh action assigned.
Value: Tag name for the preferred object
replacement
Defines the object that will replace the current object.
Value: Tag name of the object
resizable
When the value is set to yes, a user can resize a specific column.
Value: yes, no
returnkeypressedtarget
Defines the target path to pass when the onreturnkeypressed action is included.
Value: Tag name or alias of the object
returnkeytype
Defines the type of return key to display on the keyboard.
Value: Available keyboard return key types include (Not all of these types are supported in Android) :
-
go
-
search
-
send
-
done
-
next
rhs
Represents the right hand side of the condition defined.
Value: Tag name for the preferred object
rightinset
Indent text from the right.
Value: Numeric pixel value
rightof
Represents the name of an object that your object will be placed directly to the right of.
Value: Tag name for the preferred object
rowbackground
Determines the background color of a row.
Value: Alphanumeric hex value
rowcolor
Determines the font color for a row.
Value: Alphanumeric hex value
rowheight
Defines the height of the row in pixels. Row height will override all object heights defined within the tableview. If rowheight is not used, then a height will need to be defined in the tableview object's class for each item.
Value: Pixel count
rowhover
When the value is set to yes, hover state is enabled.
Value: yes, no
rowpagebreak
Specifies whether page breaks within rows are avoided when generating a PDF. If set to avoid, page breaks within a row only occur when the row height is greater than the page height. The default value is auto.
Value: auto, avoid
scalemode
When set, will allow web tags to be animated in a way that will allow the aspect ratio of the contents to be modified.
Value: Transform - default will be normal
scalingmode
Within the defined video space, scalingmode allows the video to fit within the entire space by limiting its height upon load.
Value: yes, no
scrolltarget
Defines the target object on which to perform an action, when a user scrolls horizontally or vertically within a pager. The selected action executes repeatedly as the user continues to scroll.
Value: Tag name or alias of the object
scrollawaytarget
Defines the target object on which to perform an action, when an object's scroll state moves away.
Value: Tag name or alias of the object
scrolltotarget
Defines the target object on which to perform an action, when an object's scroll action stops within the object.
Value: Tag name or alias of the object
seekto
Determines the point within the target video duration at which the action will start.
Value: Numeric value in seconds - value accepts decimals (Ex: .25)
selected
Will select the annotation on the map when set to yes.
Value: yes, no
selectedrowcolor
Determines the background color of a row that has been selected.
Value: Alphanumeric hex value
selectedrowfontcolor
Determines the font color of a row that has been selected.
Value: Alphanumeric hex value
selectiontype
Determines whether rows or cells will be selected.
Value: row, cell
selecttarget
Defines the target object that will perform the defined onselect action assigned.
Value: Tag name or alias of the object
Mobile Client for Android only
series
Specifies the data elements tracked on the x-axis of a chart.
Value: Reference to the data source
shadowopacity
Sets the alpha on the shadow. Shadows will not display on a transparent object. When using a panel, it must have a background color assigned. Shadowopacity must be used in conjunction with the shadowradius attribute.
Value: Numeric values are set between 0.0-1.0 - default value is set to 0
Mobile Client for iOS only
shadowradius
Value determines the depth of a shadow placed on an object. Shadows will not display on a transparent object. When using a panel, it must have a background color assigned. Shadowradius must be used in conjunction with the shadowopacity attribute.
Value: Numeric values set in pixels - default value is set to 0
Mobile Client for iOS only
shadowxoffset
Determines the y position of the shadow from the object. Shadows will not display on a transparent object. When using a panel, it must have a background color assigned. This attribute must be used in conjunction with the shadowopacity and shadowradius attributes.
Value: Numeric values set in pixels
Mobile Client for iOS only
shadowyoffset
Determines the x position of the shadow from the object. Shadows will not display on a transparent object. When using a panel, it must have a background color assigned. Shadowxoffset must be used in conjunction with the shadowopacity and shadowradius attributes.
Value: Numeric values set in pixels
Mobile Client for iOS only
showcontent
Determines whether the table caption is displayed on all pages of the PDF, or on a specific page. If you specify a page number that does not exist, the caption will not display.
Value: all, numeric value
showfoot
Determines whether the PDF footer is displayed. The default value is everyPage.
Value: everyPage, firstPage, never
showhead
Determines whether the PDF header is displayed. The default value is everyPage.
Value: everyPage, firstPage, never
showheader
Determines whether the header is displayed.
Value: yes, no
showpagenumber
Determines whether the page number is displayed in the PDF footer. If this value is set to yes, the footer attribute is ignored.
Value: yes, no
showscrollbar
When used, a scrollbar displays on the scrollable area.
Value: yes, no
Mobile Client for Windows PC only
showuser
Defines the location of the user's device by a blue pin within the map.
Value: yes, no
size
Specifies the font size or fit of text.
Value: Numeric character representing font size or fit- if fit is used, the font size will adjust to a size appropriate to display all text
size (textfield, dropdown)
Specifies the font size of text.
Value: Numeric character representing font size
SOAPaction
Used to hold the SOAPaction feature value.
Value: URI address
sortable
When the value is set to yes, a user can sort data in a specific column.
Value: yes, no
sortmultiple
When the value is set to yes, multiple items may be sorted.
Value: yes, no
sound
Allows a user to define the sound file that will accompany the notification.
Value: Name of any .caf file stored inside of the Wire
source
Determines the name of the file to be loaded.
Value: The name of the file stored in the Wire, with the file extension.
source (datasource)
Determines the name of the datasource being polled. For external data feeds, the source will generally be a URL.
Value:
When using Device GPS as a datasource, you can use a source of:
-
Standard: When used, the system will utilize the GPS radio.
-
Significant-Change: When used, wifi sourcing and cell towers will be utilized.
When using the camera as a datasource you can use a source of adsf – (AppleDigitalSourceFoto) This will allow you access to your source files within your camera roll.
When using contacts as a datasource you can use a wildcard (*), or a letter or specific name as a source.
spreads
Designed to isolate a page of the PDF when displayed in one, or sets of two when in landscape mode.
Value: Set this attribute to yes to display PDF pages in pairs. Set to no to isolate only the cover page while the rest of the PDF displays in pairs.
stacked
Adding the stacked attribute to a <pdf> tag will enable the PDF page scroll to lock. In order to scroll through the PDF, additional objects will need to be added to the wire to enable next and previous buttons.
Value: yes, no
startindex
Defines the row in the datasource that will be at the top of the table.
Value: Numeric character
starty
Defines the top margin on the first page of a PDF.
Value: Numeric character
state
Defined on one sibling, and can drive a specific action across all siblings when the state path is declared on the action.
Value: Value defined must match the action target set as object/@name_of_state and can only exist on one sibling within a group at a time
statusbarhide
Must be used in conjunction with the <wire> tag. When set, the window status bar does not display.
Value: yes, no
step
Defines a set of objects to pass within a list. Example: If a step is set to 2, then the list will return index numbers 1,3,5, etc.
Value: Numeric character
sticky
When the value is set to yes within an object, it will not adhere to the unload action.
Value: yes, no
stoptarget
Defines the target object on which to perform an action, when an action is completed.
Value: Tag name or alias of the object
stroke
Determines whether or not the canvas wipes away and does not return when touched. This works like a brush stroke.
Value: yes, no
style
Defines an existing style name to commit to the object.
Value: Tag name for the preferred style found within the wire
subject
Represents the subject line of the action-generated e-mail form.
Value: Alphanumeric characters
subroutine
Defines the subroutine to launch.
Value: Name of the subroutine within the Mobile Enterprise Platform component (App, SubApp, or Form) that called the wire
subroutineexittarget
Defines the targeted object to perform the defined onsubroutineexit action assigned.
Value: Tag name or alias of the object
subtitle
Determines the subtitle of the pin display.
Value: Alphanumeric characters
superwire
Defines the action to perform within the main Wire when the play tag is set within a sub-Wire.
Value: yes, no
suppress
Images with the suppress attribute will not be kept in Wire memory after it has its size determined. This includes images being served through a URL as well.
The <load> and <unload> action tags are used to manage the suppressed image content and render the image in the Wire.
Value: yes, no
swipedowntarget
Defines the target object on which to perform the action when the targeted path is swiped down.
Value: Tag name or alias of the object
swipelefttarget
Defines the target object on which to perform an action, when an object is swiped left.
Value: Tag name or alias of the object
swiperighttarget
Defines the target object on which to perform an action, when an object is swiped right.
Value: Tag name or alias of the object
swipeuptarget
Defines the target object on which to perform an action, when an object is swiped up.
Value: Tag name or alias of the object
tablelinecolor
Defines the color of the outer table border.
Value: Alphanumeric hex value
tablelinewidth
Defines the line width of the outer table. If the value is set to 0, no border is drawn.
Value: Numeric value
tablewidth
Defines the width of a table. The default value is auto.
Value: auto, wrap, or a numeric value
target
Defines the targeted object to perform the action or event.
Value: Path or alias of the object tag within the wire.
text
Determines the text to display within the dimensions of the object.
Value: Alphanumeric characters - must adhere to XML content encoding - To achieve a paragraph break within a text tag, use "\n\n"
text (richtext)
Defines the context of the tag.
Value: Formatted styling or a texttemplate path
textcolor
Defines the font color of text within a table.
Value: Alphanumeric hex value
theme
Specifies the stylistic theme for a table. Each theme has its own default styles. You can use individual attributes to override these styles. The default value is grid.
Value: grid, striped, plain
tile
The tile attribute is used to manage memory when loading individual pages of the PDF.
Value: Set no, and each page of the PDF displaying will load immediately. Set yes, and each page will load tile by tile to save memory.
time
Defines the duration of the action.
Value: Define a numeric value in seconds - value accepts decimals (Ex: .25)
time (datepicker)
Defines the content values for the native date picker element.
Value: no, yes, only
If no is selected, the date will display without the time. If only is selected, the time will display without the date. If yes is selected, both the time and date will display.
times
Defines the number of rotations performed on the object associated. This is determined based on a complete 360 degree rotation. If the degrees are reduced, the time of rotation is reduced. (Ex: An object set to 4 times with 180 degrees set will only rotate an object 2 complete times)
Value: Numeric value
title
Determines the title to display for the object.
Value: Alphanumeric characters
titlefontbold
Specifies the title font on a chart is bolded.
Value: yes, no
titlefontcolor
Specifies a color for the title font on a chart.
Value: Alphanumeric hex value
titlefontfamily
Specifies the font applied to the title text displayed in a chart. Font family is specific to the device platform.
Value: Name of font type - fonts are limited to the iOS font set
titlefontitalic
Specifies the title font on a chart is italicized.
Value: yes, no
titlefontsize
Specifies the size of the title font displayed in a chart. Font size is specific to the device platform.
Value: Numeric
titlefontunderline
Specifies the title font on a chart is underlined.
Value: yes, no
to
Sets the beginning range of the loop.
Value: Numeric value
toaddress
Represents the To: address of the action-generated email form.
Value: Alphanumeric characters
toalbum
Determines the name of the photo album to which an imagecapture or videocapture is saved. Value = alphanumeric characters
Value: Alphanumeric characters
tofile
Determines the name that will be given to the image when it is saved to the wire contents. Value = alphanumeric characters - no sibling object tags can contain the same value for the name attribute within the wire
Value: Alphanumeric characters - no sibling object tags can contain the same value for the name attribute within the wire
tofront
Moves targeted object to front of z ordering.
Value: yes, no
topof
Represents the name of an object that your object will be placed directly above.
Value: Tag name for the preferred object
tostate
The <set> tag can move the state attribute from one object to another.
Value: The target for the state attribute when placed within a group of siblings
transparent
Establishes the background of the web content as transparent.
Value: yes, no
Mobile Client for iOS only
trigger
Defines space in which onscroll actions will trigger within a pager or list. When entry is selected, the scroll action will trigger when a page enters view, even if it is still scrolling. When stop is selected a scroll action will only trigger when the pager or list comes to a complete stop. Stop is the default behavior.
Value: entry, stop
Mobile Client for iOS only
type (camera)
Instructs the camera to take photo, or function as a barcode scanner or video camera.
Value: photo, barcodescan, video
type (event)
Defines the event to run.
Value: An event type that is compatible with the targeted object. For a list of wire event types, refer to Wire event types.
type (map)
Defines the type of map to display.
Value:
hybrid, satellite, map, terrain, default
type (progress bar)
Determines the type of progress bar to display
Value:
bar, default - bar is a flattened black and white version of the standard iOS blue progress view
type (replace)
Determines the type of animation effect the replace will use. When used, the object being replaced will animate.
Value:
-
flipleft
-
flipright
-
curlup
-
curldown
-
doorsopen
-
doorsclose
-
switchright
-
switchleft
-
cuberight
-
cubeleft
-
cloth
-
flipcenterright
-
flipcenterleft
-
flipup
-
flipdown
type (reveal)
Determines the type of animation effect the reveal will use. When used, the object being revealed will animate.
Value: curlup, curldown
type (sound)
Defines the type of sound file to be actioned
Value: The file extension of the file defined as the source attribute within the sound action tag
Supported on Mobile Client for iOS
-
v1 (HE-AAC V1)
-
aac (.aac 16 to 320 Kbps)
-
mp4 (Protected AAC from iTunes Store)
-
mp3 (.mp3 16 to 320 Kbps)
-
m4a (Apple Lossless .m4a)
-
aiff (.aiff)
-
wav (.wav)
Supported on Mobile Client for Android
-
3gp (.3gp)
-
mp4 (MPEG-4 .mp4)
-
m4a (MPEG-4 .m4a)
-
aac (ADTS raw AAC .aac, decode in Android 3.1+, encode in Android 4.0+, ADIF not supported)
-
ts (MPEG-TS .ts, not seekable, Android 3.0+)
-
3gp (3GPP .3gp)
-
flac (.flac)
-
mp3 (.mp3)
-
mid (Type 0 and 1)
-
xmf (Type 0 and 1)
-
mxmf (Type 0 and 1)
-
rtttl
-
rtx
-
ota (OTA .ota)
-
imy (iMelody .imy)
-
ogg (OGG .ogg)
-
mkv (Matroska .mkv, Android 4.0+)
-
wav (WAVE .wav)
type (video)
Determines the action to perform on the video object
Value:
play or stop; pertaining to the video
url
Defines the online source of the content.
Value: URL address of web content.
url (load)
This option is the same as the file parameter, except that the location of the content resides in a remote location identified by the URL provided. URLs which return images can be used to load image content into <image> objects.The <load> tag must target a <web> tag to launch in Safari. To launch in an app, set the external attribute to "yes".
Value: URL address of web content.
For more information, refer to the following examples.
-
For web based URLs that can trigger specialize responses, enter a URL that starts with ‘http://'.For example: http://www.apple.com
-
To load a URL in mobile Safari, enter a URL that starts with ‘safari-http://'.For example: safari-http://www.apple.com
-
To launch a phone number in the native phone app, enter a URL that starts with 'tel://'. You can also use ‘telprompt://' to invoke an alert to initiate a call and return the user to the Wire when the call is complete.For example: tel://816-555-5555
-
To launch a phone number in the native message app, enter a URL that starts with ‘sms://'.For example: sms://816-555-5555
-
To load an email address in the native mail app, enter a URL that starts with ‘mailto://'.For example: mailto://rarewire@rarewire.com
-
To load the iTunes music store, enter a URL that starts with ‘itms://'.For example: itms://itunes.apple.com/us/app/fusebox/id512565578?mt=8
-
To load the Google maps application on iOS Devices, enter a URL that starts with ‘maps://'. Map addresses must be encoded.For example: maps://maps.google.com?q=New+York,+NY
user
Identifies a Twitter account to link to when using a Twitter app.
Value: Name of a Twitter account
valign
Align an object vertically.
Value: top, bottom, center
valign (pdfprint)
Defines the vertical alignment of text within a table. The default value is top.
Value: top, bottom, middle
valignment
Defines the vertical alignment of the text within the field.
Value: top, bottom, center
value (alpha)
Used to determine the amount of transparency for the target object. Defining an alpha value of 0 removes it from the user's ability to interact with the object (it will not accept any user events).
Value: A numeric value between 0.0 to 1.0
value (assign)
Represents the attribute value change on the object used in the <assign> tag.
Value: Any string - this will vary depending on the object or attribute selected
value (dropdown, dropdownitem)
The text that displays in the dropdown or dropdownitem. This can be user defined or populated from a datasource.
value (column)
The text that displays in the column. This text is populated from a datasource.
String
valueaxistitle
Specifies the name of the y-axis of a chart.
Value: Alphanumeric characters
values
Specifies the data points or data elements displayed on the y-axis of a chart.
Value: Numeric
verticalgridlines
When the value is set to yes, vertical gridlines are enabled.
Value: yes, no
verticalgridvisible
Displays a vertical grid of a chart.
Value: yes, no
videoid
Defines the ID for the YouTube video. This can be found in the URL for the video (Ex: http://www.youtube.com/watch?v=FtX8nswnUKU. The videoid is FtX8nswnUKU).
Value: Video ID of the desired YouTube video
visible
Defines the visibility of the object.
Value: yes, no
wait
Defines the wait state on a pausePreview event type.
Value: yes, no
weblinkclass
The weblinkclass attribute allows for tying the PDF to classes in the <wire> tag. When someone clicks on a web link within a PDF with weblinkclass set, a class defined in the wire is invoked.
Value: Name of a class defined within the wire
weekday
Returns the name of a weekday. The default date (today's date) is read-only.
Value: Name of the weekday
when
Allows a user to define the amount of time after the action is triggered to display this message. Defaults to zero. If the notification is triggered from an iBeacon or similar technology, the notification will still fire even if when is set to zero.
Value: Numeric characters
widesource
Defines the image that will display when a device is in landscape view.
Value: The image file stored with in the Wire - must include the file extension
width
Defines the width of an object, or the width to which the object will scale.
Value: Numeric values set in either pixels or percentages
windowtitle
Defines the title of the wire that displays in the window title bar.
Value: Alphanumeric characters
windowtitlehide
Must be used in conjunction with the <wire> tag. When set, the window title bar is not displayed.
Value: yes, no
xoffset
Defines the xpos point of the rotate on the object defined. Requires yoffset to be defined. Only works for rotations with a z axis.
Value: Numeric values set in either pixels or percentages
xpos
Defines the x axis location of the object.
Value: Numeric values set in either pixels or percentages
year
Returns the year as an integer. The default date (today's date) is read-only.
Value: integer
yoffset
Defines the ypos point of the rotate on the object defined. Requires xoffset to be defined. Only works for rotations with a z axis.
Value: Numeric values set in either pixels or percentages
ypos
Defines the y axis location of the object.
Value: Numeric values set in either pixels or percentages
zoomable
When set, the object will pinch zoom within its bounds. Zoomable cannot live at the root. It must have at least one parent assigned to base the zoom on.
Value: yes, no
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
zoomcenter
Must be used in conjunction with the zoomable attribute. When set, the object will pinch zoom from the center of the zoomable object.
Value: yes, no
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
zoommax
Must be used in conjunction with the zoomable attribute. Value will define the maximum zoom of the zoomable object.
Value: A zoom float value - default will be 1.0
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
zoommin
Must be used in conjunction with the zoomable attribute. Value will define the minimum zoom of the zoomable object.
Value: A zoom float value - default will be 1.0
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
zoomscale
Must be used in conjunction with the zoomable attribute. When set, the scale of the zoom will be defined.
Value: A zoom float value - default will be 1.0
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
zoomscroll
Must be used in conjunction with the zoomable attribute. When set, scrolling will be disabled or enabled while zooming in.
Value: yes, no
For the image and web tags, this attribute is only supported on Mobile Client for iOS and Mobile Client for Android.
For the following tags, this attribute is only supported on Mobile Client for iOS.
-
camera
-
canvas
-
chart
-
datagrid
-
datepicker
-
dropdown
-
import
-
include
-
map
-
object
-
panel
-
pdf
-
progress
-
richtext
-
tableview
-
text
-
textfield
-
video
-
youtube
Loading...
There was a problem loading this topic