Expression

An expression refers to either:

• A literal value, such as a number (e.g. 123) or a piece of text (e.g. "Hello world"); or
• A group of words or symbols that describes how to obtain the above (e.g. Contact.ShortName).

ContactsLaw allows the use of expressions in document templates, automatic descriptions for document types and workgroups, as well as various other areas. This is the basis for generating content that draws upon data from contacts, matters and so on.

Types of Expressions

Type	Example Expressions	Example Results	Remarks
Literal	123 "Hello world"	123 "Hello world"	To include double-quote characters inside a string literal, prefix with a backslash (i.e. \").
Asset	Contact Matter Address		Assets do not produce any result directly, but can be used in conjunction with some functions, e.g. Count(Contact)might evaluate to 3 if the asset represented three parties on a matter.
Property	Contact.ShortName Contact.Gender Matter.Code Address.Country	"John Smith" "Male" "678-1" "Australia"	Properties belong to assets. If an asset represents multiple contacts/matters/etc then the expression produces multiple results. Unless you specify otherwise, multiple results appear as a list of values, separated by commas (e.g. "John Smith, Fred Baker, Jane Doe").
Operator	+, -, *, / =, <>, <, >		Arithmetic operators compute numbers. Conditional operators produce either Yes or No.
Function	IsNotEmpty(Contact.LastName) Plural("word") If(Count(Contact) < 3, "friends", "acquaintances")	Yes "words" "acquaintances"	Functions compute a result based on their arguments (inputs). Function calls can be nested within each other.
Constant	NewLine NewParagraph	"␊" "␍"	Constant expressions provide a short-hand way of inserting frequently-used values, as well as text that cannot normally be entered directly (e.g. tab spaces).
Repetition	current.ShortName current.Country index	"John Smith" "Australia" 3	These expressions can only be used inside a repetition block, where they correspond to either the current instance of the repeated asset or a number indicating how many times the block has been repeated so far.

Function Reference

Text

An(word)

Produces 'a' or 'an' according to grammar rules for a particular word.

• word - Word.

Filter(text, [allowed, ...])

Filters text to allow only specific values.

• text - Text.
• allowed - Allowed values.

IsAre(value)

When there are two or more values, produces 'are'. Otherwise, produces 'is'.

• value - Number or set of values.

Lower(text)

Converts text to 'lowercase'.

• text - Text.

Optional([values, ...])

Joins consecutive values together. If any value is empty, the result is also empty.

• values - Any value.

Plural(word)

Converts a word to its plural.

• word - Singular form of the word.

PluralOf(value, word)

Converts a word to its plural when there are two or more values.

• value - Number or set of values.
• word - Singular form of the word.

Possessive(word)

Adds a possessive apostrophe to a word according to grammar rules.

• word - Word.

Replace(text, find, replace)

Replaces all occurrences of a particular word/phrase in the text.

• text - Subject text.
• find - Word/phrase to find. Can be a regular expression.
• replace - Replacement text. Can include capture groups.

ReplaceWith(text, find, replace)

Replaces the entire value if it contains a particular word/phrase.

• text - Subject text.
• find - Word/phrase to find. Can be a regular expression.
• replace - Replacement text. Can include capture groups.

Sentence(text)

Converts text to 'Sentence case'.

• text - Text.

Title(text)

Converts text to 'Title Case'.

• text - Text.

Upper(text)

Converts text to 'UPPERCASE'.

• text - Text.

Number

Number(number, [thousands = Yes])

Formats a whole number as text.

• number - Number.
• thousands - Use thousands separator (Yes/No).

Decimal(number, [decimals = 2], [thousands = Yes])

Formats a decimal number as text.

• number - Number.
• decimals - Decimal places.
• thousands - Use thousands separator (Yes/No).

Currency(number, [decimals = 2], [thousands = Yes])

Formats a currency value as text.

• number - Number.
• decimals - Decimal places.
• thousands - Use thousands separator (Yes/No).

Min(set)

Calculates the smallest value in a set.

• set - A set of values.

Max(set)

Calculates the largest value in a set.

• set - A set of values.

Sum(set)

Calculates the sum of the values in a set.

• set - A set of values.

Avg(set)

Calculates the average of a set.

• set - A set of values.

NumberInWords(number)

Converts a number to words.

• number - Number.

CurrencyInWords(number)

Converts currency to an amount in words.

• number - Number.

WordsToNumber(text)

Converts words to a number.

• text - Text.

WordsToCurrency(text)

Converts an amount in words to currency.

• text - Text.

Ordinal(number)

Adds the ordinal suffix (st/nd/rd/th) to a number.

• number - Number.