Format String

Last update: Edit

1 Introduction

The Format String widget adds a user-defined string to your page, taking object attributes as input parameters.

1.1 Typical Use Cases

Use this widget to display multiple attributes as a single string.

1.1 Features

  • Multiple attributes supported
  • Retrieve attributes one-deep

1.2 Limitations

  • Setting the same attribute multiple times using different date/time formatting is not supported

2 Properties

2.1 Data Source Tab

The data source is used to add replacements for your display string. The values from the attributes will be used to replace placeholders.

When you create a new attribute via the Edit Attributes Item dialog box, you need to enter these properties:

  • Data source
    • Variable name – identifies the attribute value; this name should be used in Display string property
    • Attribute – the value of this attribute will be used to replace ${your_Variable_Name}, defined in the Display string property
    • Empty value replacement – this string will be used when an attribute returns empty; note that this string is interpreted as HTML
  • Behavior
    • Date format – shows the date and/or time according to your locale; Relative is time relative to the current date-time
    • Date pattern (optional) – the date pattern to override the date part according to dojo/date/locale (for more information, see dojo/date/locale::format())
    • Time pattern (optional) – the time pattern to override the time part according to dojo/date/locale (for more information, see dojo/date/locale::format())
    • Render value as HTML – escapes the string value when set to No
    • Decimal precision – the amount of decimals
    • Group digits – displays a numeric value with group digits

2.2 Behavior Tab

  • On click – the microflow to be invoked on click.
  • Stop propagation – when enabled, the click action is stopped from being handled via prevention of the click event from going to other components (this can be useful when you do not want other actions like the selection in a list view to happen)
  • Display string – this string is the heart of the widget and is used as a template for the content
    • Use ${your_Variable_Name} to have the attribute value inserted into this string
    • Note that except for the replacements, this string is interpreted as HTML
  • Class string – use ${your_Variable_Name} to have the attribute value used in the className of the widget (if you want to use multiple classes, make sure you separate them with spaces)
  • Translatable strings – with this property, you can use translatable strings (instead of the internal language pack)
  • Locale selection – when you use the internal language pack, only a few languages are supported – choose Automatic to let Dojo choose based on the application (with a fallback to en-us)

2.3 Customization Tab

These are the values that you can change when you use Translatable strings:

  • String value for second
  • String value for seconds
  • String value for minute
  • String value for minutes
  • String value for hour
  • String value for hours
  • String value for day
  • String value for days
  • String value for week
  • String value for weeks
  • String value for month
  • String value for months
  • String value for year
  • String value for years
  • String value for from now
  • String value for ago

3 Example Scenario

In this scenario, you have an attribute that contains a hyperlink to a website (for example, The attribute is called Link.

You want to show this link as a simple HTML link.

Here is how you do that:

  1. Add Link as an Attribute on the Data Source tab.
  2. Enter LinkVariable for the Variable name.
  3. Set the Display string to <a href="${LinkVariable}" target="_blank">Link Text</a> on the Behavior tab.