Functions Overview

Dismiss this until next updateThis documentation has been updated

The latest version of PrintShop Mail is currently 7.1. This documentation was updated on 2011-03-29 and covers the changes made in this version. If you are still using an older version of PrintShop Mail, you can access its documentation by using the Version: menu at the top-right corner of this screen.

If you wish to upgrade to PrintShop Mail7.1, you can do so via the Upgrade Request page. Note that in order to upgrade, you will need a valid OL Care contract as of 2010-09.

Functions Overview

You can use the following functions in PrintShop Mail:

Operator	Function
ABS	Returns the absolute value of <Number>.
AND	Returns True if both <Logical value 1> and <Logical value 2> are True.
ASC	Converts the leading character in <Text> to its numeric UNICODE value.
BLANK	Layout action constant. If your layout condition evaluates to BLANK, then the layout will be left blank when the document is printed.
CHANGED	Returns True if the current expression result differs from the result of the previous record.
CHR	Returns the character represented by UNICODE index <Number>.
CODABAR	Computes a CODABAR barcode.
CODE128	Computes a CODE128 barcode.
CODE39	Computes a CODE39 barcode.
CONTAINS	Returns True if <Text> contains <Text to find>, returns False otherwise.
COUNTER	A counter which by default counts from the first to the last record. Arguments are optional.
DATE	Returns the current date, formatted according to <Date string format> (optional) or the system regional settings.
DIV	Returns the integral quotient from dividing <Number> by <Divider>.
EAN13	Computes an EAN13 barcode.
EAN8	Computes an EAN8 barcode.
FALSE	Logical constant False.
FILE_EXIST	Returns True if the file <Filename> exist on disk.
IF	Gives one of two results depending on a condition you specify.
INT	Returns the integral part of a floating point number.
ITF	Computes an ITF barcode.
JAN13	Computes a JAN13 barcode.
JAN8	Computes a JAN8 barcode.
KIX	Computes a KIX barcode.
LAYOUT_COUNT	Returns the number of layouts associated with the current record, taking into account any skipped layouts.
LAYOUT_NR	Layout counter that is reset after every record. It does not count skipped layouts. Note: LAYOUT_NR cannot be used in layout conditions.
LEFT	Returns the specified number of characters in the supplied text, counting from the left.
LEN	Returns the number of characters in <Text>.
LOWER	Returns all letters in the given text as lowercase.
LTRIM	Returns the supplied text, stripped of all leading spaces, tabs and newline characters.
MID	Extracts characters from the supplied text, starting at the character position specified by start position and containing the number of characters specified by size.
MOD	Returns the remainder after the specified number is divided by a divisor.
MSI	Computes a MSI Plessey barcode.
NOT	Returns True if <Logical value> is False, and False otherwise.
NW7	Any expression which results in a logical value, example True or False.
OBJECT_EMPTY	Determines whether a object with the specified name is empty. Returns True or False.
ONECODE	Computes a ONECODE barcode.
OR	Returns True if either <Logical value 1> or <Logical value 2> is True.
PAGE_COUNT	Returns the total number of pages at printing for this document.
PAGE_NR	Returns the page number at printing time, or 1 at design time. Note: PAGE_NR cannot be used in layout conditions.
POS	Returns the character position of a searched string in text. Returns 0 if not found.
POSTNET	Converts a 5 digit (zip code), 9 digit (zip+4 code), or an 11 digit (delivery point barcode) to a valid POSTNET barcode.
PRINT	Layout action constant, can only be used in layout conditions.
PROPER	Convert the first letter of each word to an uppercase character, and the rest to lowercase.
RECORD_COUNT	Returns the total number of records of the database.
RECORD_NR	Returns the current record number of the database.
REPLACE	Looks for <Text to find> in <Text> and replaces every occurrence with <Replace with text>.
RIGHT	Returns the specified number of characters in the supplied text, counting from the right.
ROUND	Returns the supplied number rounded off to the specified number of decimal places.
RTRIM	Returns the supplied text, stripped of all trailing spaces, tabs and newline characters.
SGN	Returns one of three possible values (-1, 0 or 1), depending whether the number is negative, zero, or positive.
SKIP	Layout action constant, can only be used in layout conditions.
STR	Converts a number to data type Text, for use with functions that expect text arguments.
TEXT_FILE	Returns the contents of the TXT or RTF file <Filename>.
TODAY	Returns the current date, according to the computers internal calender, formatted according to the system regional settings.
TOTALPAGES	Returns the number of pages in a PDF file, or the number of frames in a multi-frame TIFF or GIF file.
TRIM	Returns the supplied text, stripped of all leading and training spaces, tabs and newline characters.
TRUE	Logical constant True.
UPCA	Computes a UPCA barcode.
UPCE	Computes a UPCE barcode.
UPPER	Returns all letters in the given text as uppercase. Use the UPPER function to ensure consistent data entry of such things as state abbreviations or postal codes.
VAL	Converts a string representing a number to data type Number, for use in functions that expect numeric arguments.
YuBar	Computes a YuBar barcode.

Operator

Function

ABS

Returns the absolute value of <Number>.

AND

Returns True if both <Logical value 1> and <Logical value 2> are True.

ASC

Converts the leading character in <Text> to its numeric UNICODE value.

BLANK

Layout action constant. If your layout condition evaluates to BLANK, then the layout will be left blank when the document is printed.

CHANGED

Returns True if the current expression result differs from the result of the previous record.

CHR

Returns the character represented by UNICODE index <Number>.

CODABAR

Computes a CODABAR barcode.

CODE128

Computes a CODE128 barcode.

CODE39

Computes a CODE39 barcode.

CONTAINS

Returns True if <Text> contains <Text to find>, returns False otherwise.

COUNTER

A counter which by default counts from the first to the last record. Arguments are optional.

DATE

Returns the current date, formatted according to <Date string format> (optional) or the system regional settings.

DIV

Returns the integral quotient from dividing <Number> by <Divider>.

EAN13

Computes an EAN13 barcode.

EAN8

Computes an EAN8 barcode.

FALSE

Logical constant False.

FILE_EXIST

Returns True if the file <Filename> exist on disk.

Gives one of two results depending on a condition you specify.

INT

Returns the integral part of a floating point number.

ITF

Computes an ITF barcode.

JAN13

Computes a JAN13 barcode.

JAN8

Computes a JAN8 barcode.

KIX

Computes a KIX barcode.

LAYOUT_COUNT

Returns the number of layouts associated with the current record, taking into account any skipped layouts.

LAYOUT_NR

Layout counter that is reset after every record. It does not count skipped layouts. Note: LAYOUT_NR cannot be used in layout conditions.

LEFT

Returns the specified number of characters in the supplied text, counting from the left.

LEN

Returns the number of characters in <Text>.

LOWER

Returns all letters in the given text as lowercase.

LTRIM

Returns the supplied text, stripped of all leading spaces, tabs and newline characters.

MID

Extracts characters from the supplied text, starting at the character position specified by start position and containing the number of characters specified by size.

MOD

Returns the remainder after the specified number is divided by a divisor.

MSI

Computes a MSI Plessey barcode.

NOT

Returns True if <Logical value> is False, and False otherwise.

NW7

Any expression which results in a logical value, example True or False.

OBJECT_EMPTY

Determines whether a object with the specified name is empty. Returns True or False.

ONECODE

Computes a ONECODE barcode.

Returns True if either <Logical value 1> or <Logical value 2> is True.

PAGE_COUNT

Returns the total number of pages at printing for this document.

PAGE_NR

Returns the page number at printing time, or 1 at design time. Note: PAGE_NR cannot be used in layout conditions.

POS

Returns the character position of a searched string in text. Returns 0 if not found.

POSTNET

Converts a 5 digit (zip code), 9 digit (zip+4 code), or an 11 digit (delivery point barcode) to a valid POSTNET barcode.

Layout action constant, can only be used in layout conditions.

PROPER

Convert the first letter of each word to an uppercase character, and the rest to lowercase.

RECORD_COUNT

Returns the total number of records of the database.

RECORD_NR

Returns the current record number of the database.

REPLACE

Looks for <Text to find> in <Text> and replaces every occurrence with <Replace with text>.

RIGHT

Returns the specified number of characters in the supplied text, counting from the right.

ROUND

Returns the supplied number rounded off to the specified number of decimal places.

RTRIM

Returns the supplied text, stripped of all trailing spaces, tabs and newline characters.

SGN

Returns one of three possible values (-1, 0 or 1), depending whether the number is negative, zero, or positive.

SKIP

Layout action constant, can only be used in layout conditions.

STR

Converts a number to data type Text, for use with functions that expect text arguments.

TEXT_FILE

Returns the contents of the TXT or RTF file <Filename>.

TODAY

Returns the current date, according to the computers internal calender, formatted according to the system regional settings.

TOTALPAGES

Returns the number of pages in a PDF file, or the number of frames in a multi-frame TIFF or GIF file.

TRIM

Returns the supplied text, stripped of all leading and training spaces, tabs and newline characters.

TRUE

Logical constant True.

UPCA

Computes a UPCA barcode.

UPCE

Computes a UPCE barcode.

UPPER

Returns all letters in the given text as uppercase. Use the UPPER function to ensure consistent data entry of such things as state abbreviations or postal codes.

VAL

Converts a string representing a number to data type Number, for use in functions that expect numeric arguments.

YuBar

Computes a YuBar barcode.