Value formatters in DOCX, XLSX and PPTX templates

You can use formatters to add complex logic to values rendered in your templates. For example, you can change value format, hide content, join arrays, etc.

This article covers formatters for DOCX, XLSX and PPTX templates.

Note

Please follow the link to review a page with deprecated formatters.

format

It formats a tag value. You can use it with or without parameters:

  • format - if encountered on date value it will format it as short date string.

  • format(val) - formats current value using specified format string. For example, you can use N2 for a numbers with two decimals.

  • format(val, locale) - formats current value using specified format string and Locale. For example, you can use format(C, fr-FR) to apply a specific currency to the tag.

Note

If you want to use colon character : with the formatter then it must be escaped with a backslash

  • {{date}:format(hh\:mm)}

It uses standard format strings and supports different Locales. For example, you can place tags with different locales in a docx template

  • {{num1}:format(C, ru-RU)}

  • {{num2}:format(C, fr-FR)}

Please find more information about using Locale in the Microsoft documentation:

Examples

Template

Data

Result

Date: {{date}:format(dd.MM.yyyy)}
Date: {{date}:format(MM/dd)}
Date: {{date}:format(U)}
Number: {{num}:format(C)}
Number: {{num}:format(C, fr-FR)}
Number: {{num}:format(P)}
Number: {{num}:format(N2)}
{
    "date": "2012-04-21T18:25:43-05:00",
    "num": 8
}
Date: 22 Apr 2012
Date: 04/22
Date: Saturday, April 21, 2012 11:25:43 PM
Number: $8.00
Number: 8.00 €
Number: 800.00%
Number: 8.00

map

map accepts an unlimited number of values and maps a specific value to a specific output.

For example, we have some property that stores delivery types and has values:

  • EmailShipping

  • ElectronicalShipping

And we want to display them in a readable format

  • Email shipping

  • Electronic shipping

Template

Data

Result

{{DeliveryType}:map("EmailShipping" = "Email shipping", "ElectronicShipping" = "Electronic shipping")}
{
    "DeliveryType": "EmailShipping"
}
Email shipping

Note

All values in double quotes are recognised as strings. If you want to map numbers, you don’t need to use double quotes in the condition.

For example, {{tag}:map("Yes" = 1, "No" = 0)}.

barcode

{{value}:barcode(type, width, height)} inserts a barcode with a certain type, width and height into template. Please review this how-to .

Note

To use the formatter with PowerPoint templates you need to prepare your pptx template. Please check out the article QR Codes and barcodes in PPTX templates .

Template

Data

Result

{{value}:barcode(CODE128, 301, 100)}
{
    "value": "test barcode"
}

the barcode

Barcode formatter result

You need to specify the barcode type in the tag.

There are different types of the barcodes .

CODE128

Template:

{{value}:barcode(CODE128, 200, 100)}

JSON:

{
      "value": "12345678"
}

CODE11

Template:

{{value}:barcode(CODE11, 200, 100)}

JSON:

{
      "value": "01234567"
}

CODE39

Template:

{{value}:barcode(CODE39, 200, 100)}

JSON:

{
      "value": "ABC1234"
}

UPCA

Template:

{{value}:barcode(UPCA, 200, 100)}

JSON:

{
      "value": "72527273070"
}

MSI

Template:

{{value}:barcode(MSI, 200, 100)}

JSON:

{
      "value": "01234567"
}

ISBN

Template:

{{value}:barcode(ISBN, 200, 100)}

JSON:

{
      "value": "9781234567897"
}

EAN13

Template:

{{value}:barcode(EAN13, 200, 100)}

JSON:

{
      "value": "978020137962"
}

ITF14

Template:

{{value}:barcode(ITF14, 200, 100)}

JSON:

{
      "value": "01234567890123"
}

qrcode

qrcode(size) inserts a QR code into template. You can specify only one dimension since width = height for QR codes.

Note

To use the formatter with PowerPoint templates you need to prepare your ppts template. Please check out the article QR Codes and barcodes in PPTX templates .

Template

Data

Result

{{value}:qrcode(5)}
{
    "value": "https://www.plumsail.com/"
}

the qrcode

Qrcode formatter result

There are different types of QR codes, you can specify it in the JSON.

URL

To encode the text of a URL, for example, https://www.plumsail.com/, encode the https://www.plumsail.com/ URL text in the JSON. Include the http:// protocol to ensure it is recognized as a URL.

{
      "value": "https://www.plumsail.com/"
}

Telephone Numbers

To encode a telephone number, use a telephone URI to ensure that the digits are recognized as a telephone number and include prefixes which make the number internationally accessible.

{
      "value": "tel:+1-234-555-6677"
}

SMS

To encode an SMS short code or number, create an SMS URI. For example, to create a link to the 12345 number, encode sms:12345. You may use other URI forms, such as sms:number:subject, and other prefixes, such as smsto:.

{
      "value": "sms:12345"
}

Geolocations

To encode a point on the earth, including altitude, use a geo URI.

{
      "value": "geo:42.65049,23.37925,100"
}

Hint

Read this article to get inspired on how to enrich your documents with various QR codes.

substring

Returns substring. You can use the formatter with one or two parameters:

  • substring(index) - returns substring of provided values after index chars

  • substring(index,length) - returns substring of provided values after index with length.

Examples

Template

Data

Result

{{stringVal}:substring(6)}
{{stringVal}:substring(0,5)}
{
    "stringVal": "Derek Clark"
}
Clark
Derek

sum

It calculates a sum of the values in an array:

  • {{items}:sum()} for items in the array,

  • {{items}:sum(value.property)} for a property in the array of objects,

  • {{items}:sum(value.property1 * value.property2)} for arithmetical actions with the properties in the array of objects.

The following operators are available:

  • + addition,

  • - subtraction,

  • * multiplication,

  • / division,

  • % remainder of division.

Examples

Template

Data

Result

Total:
{{items}:sum()}
{
  "items": [3, 2, 7]
}
Total:
12
Total quantity:
{{sales}:sum(value.quantity)}

Total amount:
${{sales}:sum(value.quantity * value.price)}
{
  "sales": [
    {
      "price": 3,
      "quantity": 90
    },
    {
      "price": 4,
      "quantity": 60
    },
    {
      "price": 5,
      "quantity": 30
    }
  ]
}
Total quantity:
180

Total amount:
$660

avg

It calculates an average of the values in an array:

  • {{items}:avg()} for items in the array,

  • {{items}:avg(value.property)} for a property in the array of objects,

  • {{items}:avg(value.property1 * value.property2)} for arithmetical actions with the properties in the array of objects.

The following operators are available:

  • + addition,

  • - subtraction,

  • * multiplication,

  • / division,

  • % remainder of division.

Examples

Template

Data

Result

Average:
{{items}:avg()}
{
  "items": [3, 2, 7]
}
Average:
4
Average quantity:
{{sales}:avg(value.quantity)}

Average amount:
${{sales}:avg(value.quantity * value.price)}
{
  "sales": [
    {
      "price": 3,
      "quantity": 90
    },
    {
      "price": 4,
      "quantity": 60
    },
    {
      "price": 5,
      "quantity": 30
    }
  ]
}
Average quantity:
60

Average amount:
$220

count

It counts the number of values in an array, total or only those that meet a condition:

  • {{items}:count()} or {{items}:count(value > 10)} for items in the array,

  • {{items}:count(value.property)} or {{items}:count(value.property > 10)} for a property in the array of objects,

  • {{items}:count(value.property1 > value.property2)} for several properties in the array of objects.

The following operators are available:

  • > greater than,

  • >= greater than or equal to,

  • < less than,

  • <= less than or equal to,

  • == equal to,

  • != not equal to,

  • && logical AND,

  • || logical OR.

Examples

Template

Data

Result

Items:
{{items}:count()}

Items greater than 3:
{{items}:count(value > 3)}
{
  "items": [3, 2, 7]
}
Items:
3

Items greater than 3:
1
Sales reports:
{{sales}:count()}

Quantity greater than 40:
{{sales}:count(value.quantity > 40)}

Amount greater than $200 and less than $250:
{{sales}:count(value.quantity * value.price > 200
&& value.quantity * value.price < 250)}
{
  "sales": [
    {
      "price": 3,
      "quantity": 90
    },
    {
      "price": 4,
      "quantity": 60
    },
    {
      "price": 5,
      "quantity": 30
    }
  ]
}
Sales reports:
3

Quantity greater than 40:
2

Amount greater than $200 and less than $250:
1

join

join(separator, order) - joins array values with a separator and sorts them in a specific order.

Examples

Template

Data

Result

{{arr}:join(", ", ASC)}
{{arr}:join("-", DESC)}

{{arr}:join(; )}
{{arr}:join( : )}
{
    "arr": [2, 1, 3]
}
1, 2, 3
3-2-1

2; 1; 3
2 : 1 : 3

offset

offset(d) - date and time value will be offset by d days.

offset(d.hh\:mm\:ss) - advanced approach for offsetting d days, hh hours, mm minutes, ss seconds.

Note

If you want to use colon character : with the formatter then it must be escaped with a backslash

Just replace d, hh, mm and ss by the required number of days, hours, minutes and seconds in this string pattern d.hh\:mm\:ss.

Examples

Template

Data

Result

Without offset:
{{date}}

Plus 10 days
{{date}:offset(10)}

Minus 10 days:
{{date}:offset(-10)}

Plus 10 days, 1 hour,
5 minutes, 10 seconds:
{{date}:offset(10.1\:5\:10)}

Minus 10 days, 1 hour,
5 minutes, 10 seconds:
{{date}:offset(-10.1\:5\:10)}
{
    "date": "2012-04-21T18:25:43-05:00"
}
Without offset:
4/22/2012 3:25:43 AM

Plus 10 days
5/2/2012 3:25:43 AM

Minus 10 days:
4/12/2012 3:25:43 AM

Plus 10 days, 1 hour,
5 minutes, 10 seconds:
5/2/2012 4:30:53 AM

Minus 10 days, 1 hour,
5 minutes, 10 seconds:
4/12/2012 2:20:33 AM

hide

hide - replaces current tag value with an empty string. It can be used to hide the content of a specific tag.

Examples

Template

Data

Result

{{val1}}
{{val2}:hide}
{
    "val1":"Derek Clark",
    "val2":"Jessica Adams"
}
Derek Clark

hide-block-if

It can be used to conditionally hide a single block of the document. The formatter works in the rich text content control or repeatable sections such as list items or table rows. Thus, if you need to hide some atbitrary block, it is necessary to put it in a list item or table cell with invisible borders. The argument may contain either a value or a logical expression that returns true or false.

In the first case, if a value in the token is equal to a value of the parameter, it will be applied.

{{items.property}:hide-block-if(val)}

In the second case, if a value in the token makes the expression in the parameter true, it only hides the current block. Additionally, you need to repeat the token without the formatter to render a value. When building the expression, refer to the current token value as value and if it contains nested objects, refer to them through a period like value.property.

{{items}:hide-block-if(value.property == "red")} {{items.property}}

The following operators are available:

  • > greater than,

  • >= greater than or equal to,

  • < less than,

  • <= less than or equal to,

  • == equal to,

  • != not equal to,

  • && logical AND,

  • || logical OR.

Note

To hide items from an array, we recommend to use the filter operation instead of the current formatter. The latter should be used only for hiding arbitrary blocks.

Examples

The formatter can be used in DOCX, XLSX, and PPTX templates. However, in XLSX templates, it behaves differently. Read the articles below for more information:

Template

Data

{{count}:hide-block-if(value == 1)}
{{count}}

or

{{count}:hide-block-if(1)}
{
    "count": 1
}
{{employee}:hide-block-if(value.name == "Jessica")}
{{employee.name}}

or

{{employee.name}:hide-block-if(Jessica)}
{
    "employee": {
        "name": "Jessica"
    }
}

hide-block-if-nothing

It is applied if a value in the tag is null, an empty string or array. The formatter can be used to conditionally hide a single block of the document. It works in the rich text content control or repeatable sections such as list items or table rows. Thus, if you need to hide some arbitrary block, it is necessary to put it in a list item or table cell with invisible borders.

{{property}:hide-block-if-nothing}

If a value in the token is not empty and you want to add a value of the token to the block, you need to repeat the token without the formatter to render a value.

{{property}:hide-block-if-nothing} {{property}}

Note

To hide items from an array, we recommend to use the filter operation instead of the current formatter. The latter should be used only for hiding arbitrary blocks.

Examples

The formatter can be used in DOCX, XLSX, and PPTX templates. However, in XLSX templates, it behaves differently. Read the articles below for more information:

Template

Data

{{property}:hide-block-if-nothing}
{{property}}

or

{{property}:hide-block-if-nothing}
{
    "property": null
}

{
    "property": ""
}

{
    "property": []
}

bool

bool(yes,no,maybe) - boolean value will be converted to yes, no or maybe. You can specify your own value for each state. The last parameter is optional. You can use it if your bool value can be null.

Examples

Template

Data

Result

{{boolVal1}:bool(yes,no,maybe)}
{{boolVal2}:bool(yes,no,maybe)}
{{boolVal3}:bool(yes,no,maybe)}
{
    "boolVal1": true,
    "boolVal2": false,
    "boolVal3": null,
}
yes
no
maybe

empty

empty(val) - if a value in a tag is null, empty or empty array it will replace the value with val. You can use this formatter to display default value. For example, “N/A”.

Examples

Template

Data

Result

{{val1}:empty(N/A)}
{{val2}:empty(N/A)}
{{val3}:empty(N/A)}
{
    "val1": "Jessica Adams",
    "val2": "",
    "val3": [],
}
Jessica Adams
N/A
N/A

merge-nulls

merge-nulls - use this formatter to merge table cells horizontally if there is null value.

Note

This formatter can be used in both DOCX and XLSX templates. However, Excel doesn’t support merging cells in table ranges. Thus, if you want to use this formatter, apply it to regular Excel cells instead. See the example below.

Examples

Template

Data

Result

DOCX template:

merge nulls formatter template

XLSX template (download):

merge nulls formatter template
{
    "collection": [
        {
            "name": "Derek Clark",
            "sold": null
        },
        {
            "name": "Jessica Adams",
            "sold": 14000
        },
        {
            "name": "Xue Li",
            "sold": null
        },
        {
            "name": "Martin Huston",
            "sold": 9400
        },
        {
            "name": "Anton Frolov",
            "sold": null
        }
    ]
}

Cells with null values were merged.

DOCX result:

merge nulls fortammer result

XLSX result (download result):

merge nulls fortammer result

span-nulls

span-nulls - use this formatter to merge table cells vertically if there is null value.

Important

This formatter can be used in DOCX templates only.

Examples

Template

Data

Result

Download template document

span nulls formatter template
{
    "collection": [
        {
            "name": "Derek Clark",
            "sold": null,
            "period": "Jan 2018"
        },
        {
            "name": "Jessica Adams",
            "sold": 14000,
            "period": "Feb 2018"
        },
        {
            "name": "Xue Li",
            "sold": null,
            "period": "Mar 2018"
        },
        {
            "name": "Martin Huston",
            "sold": 9400,
            "period": "May 2018"
        },
        {
            "name": "Anton Frolov",
            "sold": null,
            "period": "Jun 2018"
        }
    ]
}

Download result document

span nulls fortammer result

horizontal-resize

horizontal-resize - it can be used to repeat collections horizontally instead of vertically in Excel. See the example below.

Important

This formatter can be used in XLSX templates only.

Examples

Template

Data

Result

horizontal-resize formatter template
{
    "collection": [
        {
            "name": "Derek Clark"
        },
        {
            "name": "Jessica Adams"
        },
        {
            "name": "Xue Li"
        }
    ]
}

New columns are added instead of new rows:

horizontal-resize formatter result

page

page - it can be used for changing the logic of repeating collections. When a tag is placed inside the table and you want to repeat entire page instead of a table row, use page to override default repeating logic.

Important

This formatter can be used in DOCX templates only.

Examples

Template

Data

Result

page formatter template
{
    "collection": [
        {
            "name": "Derek Clark",
            "sold": 10000
        },
        {
            "name": "Jessica Adams",
            "sold": 14000
        },
        {
            "name": "Xue Li",
            "sold": 9400
        }
    ]
}

New pages are added instead of new table rows:

page formatter result

sheet

sheet - it can be used for changing the logic of repeating collections. When a tag is placed inside the table and you want to create a separate sheet for each collection item instead of a table row, use sheet to override default repeating logic.

Important

This formatter can be used in XLSX templates only.

Examples

Template

Data

Result

sheet formatter template
{
    "collection": [
        {
            "name": "Derek Clark",
            "sold": 10000
        },
        {
            "name": "Jessica Adams",
            "sold": 14000
        },
        {
            "name": "Xue Li",
            "sold": 9400
        }
    ]
}

New sheets are added instead of new table rows:

sheet formatter result

picture

picture - it resolves URL or base64 string and converts it to an image.

The formatter doesn’t compress the source picture and keeps its quality.

picture formatter can be used with resizing options, for example, {{value}:picture(100,100)} .

Also you can specify only the width parameter and height will be calculated automatically to keep the image proportions.

For example, {{value}:picture(50)} .

The formatter can be used in both DOCX and PPTX templates. Read the articles below for more information:

Note

Resizing of an image is not supported for PPTX templates yet.

Note

picture formatter supports SVG images. However, the result is visible only in the Office desktop version starting from Office 2017.

Examples

Template

Data

Result

{{value}:picture},

{{value}:picture(100,100)},

{{value}:picture(50)}
{
    "value": "https://picturesite.com/pics/picture.png"
}


{
    "value": "iVBORw0KGgoAAAANSUhEUgAAAIAAAAA9CAYAAABlamFgAA"
}
the image

You can also place the picture formatter into Alt text of a picture. This way you can control the inserted picture size as well.

Alt text picture formatter

rotate, flip

You can rotate and/or flip a picture using rotate and flip formatters with the picture formatter.

Examples

Template

Data

Result

{{value}:picture(100):flip(X):rotate(90)}
{{value}:picture(100):rotate(90):flip(X)}
{{value}:picture(100):rotate(90):flip(Y)}
{{value}:picture(100):rotate(90):flip(XY)}
{
    "value": "https://picturesite.com/pics/picture.png"
}


{
    "value": "iVBORw0KGgoAAAANSUhEUgAAAIAAAAA9CAYAAABl"
}
the image

Note

Rotation supports only the following values: 90, 180, 270, 360

pictureCompress

pictureCompress - it resolves URL or base64 string and converts it to an image. This formatter compresses the source picture. pictureCompress formatter can be used with resizing options, for example, {{value}:pictureCompress(100,100)} . Also you can specify only the width parameter and height will be calculated automatically to keep the image proportions. For example, {{value}:pictureCompress(50)} .

The formatter can be used in both DOCX and PPTX templates. Read the articles below for more information:

Note

Resizing of an image is not supported for PPTX templates yet.

Examples

Template

Data

Result

{{value}:pictureCompress},
{{value}:pictureCompress(100,100)},
{{value}:pictureCompress(50)}
{
    "value": "https://picturesite.com/pics/picture.png"
}


{
    "value": "iVBORw0KGgoAAAANSUhEUgAAAIAAAAA9CAYAAABl"
}
the image

url

url - it corrects an url to full qualified with HTTP scheme or checks correctness when a scheme is existing. When result URL is not correct - removes it from the document

Template

Data

Result

{{value}:url}
{
    "value": "picturesite.com/pics/picture.png"
}

{
    "value": "ya.ru"
}

{
    "value": ".net"
}
http://picturesite.com/pics/picture.png

http://ya.ru

keep-token

keep-token keeps tokens as they are.

It can be useful in case you have other system tags in double curly brackets (for instance, Adobe Sign text tags).

Or you have some text enclosed with double curly brackets as a part of a document.

Template

Result

{{value}:keep-token}
{{Sig_es_:signer1:signature}:keep-token}
{{value}}
{{Sig_es_:signer1:signature}}

html

html - it converts provided HTML code into docx text and elements.

Note

html formatter is only supported in DOCX documents.

Template

Data

Result

{{text}:html}
{
    "text": "<html><head><title></title></head>
    <body>This is HTML</body></html>"
}

docx file with the HTML

HTML formatter result

This is a list of supported HTML tags:

  • <a>

  • <h1-h6>

  • <abbr> and <acronym>

  • <b>, <i>, <u>, <s>, <del>, <ins>, <em>, <strike>, <strong>

  • <br> and <hr>

  • <table>, <td>, <tr>, <th>, <tbody>, <thead>, <tfoot> and <caption>

  • <cite>

  • <div>, <span>, <font> and <p>

  • <pre>

  • <sub> and <sup>

  • <ul>, <ol> and <li>

  • <dd> and <dt>

  • <q> and <blockquote>

  • <article>, <aside>, <section> are considered like <div>

Javascript (<script>), CSS <style>, <meta> and other not supported tags does not generate an error but are ignored.

You can also upload a source HTML from any connector: SharePoint, OneDrive, etc, and use the dynamic content in Plumsail actions.

HTML formatter result

checkbox

checkbox - activates checkboxes in a DOCX template.

For example, a user fills out some online form and the formatter activates checkboxes in a DOCX template depending on the forms’ values.

The result DOCX document could be an application or questionnaire.

Find more information about using the formatter in the article How to populate Word with checkboxes using Power Automate.

Template

Data

Result

{{prop1}:checkbox}
{{prop2}:checkbox}
{
    "prop1": true,
    "prop2": false
}

DOCX file with activated checkboxes

Checkbox formatter result