Value formatters in DOCX, XLSX and PPTX templates¶

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.

• {{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:

• Numeric format strings

• Date and time format strings

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

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

{
    "DeliveryType": "EmailShipping"
}

Email shipping

barcode¶

{{value}:barcode(type, width, height)} inserts a barcode with a certain type, width and height into template.

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

{
    "value": "test barcode"
}

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.

{{value}:qrcode(5)}

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

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"
}

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.

{{stringVal}:substring(6)}
{{stringVal}:substring(0,5)}

{
    "stringVal": "Derek Clark"
}

Clark
Derek

join¶

join(separator) - joins array values with a separator.

{{arr}:join(, )}
{{arr}:join(; )}
{{arr}:join(-)}

{
    "arr": [ 1, 2, 3]
}

1, 2, 3
1; 2; 3
1-2-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.

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.

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.

{{val1}}
{{val2}:hide}

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

Derek Clark

hide-block-if¶

hide-block-if(val) - it can be used to conditionally hide blocks of a document. If a value in the tag is equal to a value of the parameter, it will be applied. This formatter works in repeatable sections such as list items or table rows.

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

{{value}:hide-block-if(Jessica)}

{{value}:hide-block-if([1, 2])}

{{value}:hide-block-if(Jessica, John)}

{
    "value": 1
}

{
    "value": "Jessica"
}

{
    "value": [1, 2]
}

{
    "value": [Jessica, John]
}

hide-block-if-not¶

hide-block-if-not(val) - it can be used to conditionally hide all block of list or table except specified. If a value in the tag is equal to a value of the parameter, it will be applied. This formatter works in repeatable sections such as list items or table rows.

{{value}:hide-block-if-not(1)}

{{value}:hide-block-if-not(Jessica)}

{{value}:hide-block-if-not([1, 2])}

{{value}:hide-block-if-not(Jessica, John)}

{
    "value": 1
}

{
    "value": "Jessica"
}

{
    "value": [1, 2]
}

{
    "value": [Jessica, John]
}

hide-block-if-empty¶

hide-block-if-empty - it can be used to conditionally hide blocks of a document. If a value in the tag is null, empty or empty array, it will be applied. This formatter works in repeatable sections such as list items or table rows.

{{value}:hide-block-if-empty}

{
    "value": null
}

{
    "value": ""
}

{
    "value": []
}

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.

{{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”.

{{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.

Examples¶

Template	Data	Result
DOCX template: XLSX template (download):	{ "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: XLSX result (download result):

span-nulls¶

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

Examples¶

Template	Data	Result
Download template document	{ "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

horizontal-resize¶

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

Examples¶

Template	Data	Result
	{ "collection": [ { "name": "Derek Clark" }, { "name": "Jessica Adams" }, { "name": "Xue Li" } ] }	New columns are added instead of new rows:

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.

Examples¶

Template	Data	Result
	{ "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:

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.

Examples¶

Template	Data	Result
	{ "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:

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:

• Pictures in DOCX templates

• Pictures in PPTX templates

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

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


{
    "value": "iVBORw0KGgoAAAANSUhEUgAAAIAAAAA9CAYAAABlamFgAA"
}

the image

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:

• Pictures in DOCX templates

• Pictures in PPTX templates

{{value}:pictureCompress}, {{value}:pictureCompress(100,100)}, {{value}:pictureCompress(50)}

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


{
    "value": "iVBORw0KGgoAAAANSUhEUgAAAIAAAAA9CAYAAABlamFgAA"
}

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

{{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.

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

{{value}}
{{Sig_es_:signer1:signature}}