Text Supplier

Overview

Provides information about text values.

Details

Name:

Text Supplier

Prefix:

text

(optional)

Supported Content:

Text

Provided By:

Supported Keys

The following are the list of keys which this supplier will return a value for.

Key

Content Types

Return Type

Description

size

Text

The number of characters in the text value.

trim

Text

Text

Trims any white space (spaces, tabs, etc) from the text value.

lower case

Text

Text

Converts the text to lower case.

upper case

Text

Text

Converts the text to upper case.

first [X]

Text

Text

Trims the text to only include the first X characters. For example, "first 10".

after first [X]

Text

Text

(Since 4.0.0) Trims the text to only include characters after the first X. For example: "after first 10".

last [X]

Text

Text

Trims the text to only include the last X characters. For example, "last 15".

before last [X]

Text

Text

(Since 4.0.0) Trims the text to only include characters before the last X characters. For example "before last 10".

url encode

Text

Text

URL-encodes the text value so it is safe to include in a URL.

html escape

Text

Text

Escapes any special HTML characters so they will display correctly in HTML content.

xml escape

Text

Text

Escapes any special XML characters so they will display correctly in XML content.

equals [X]

Text

(Since 2.0.0) Tests if the text equals the 'X' value supplied.

e.g.: "equals Foo Bar". This is case-sensitive.

starts with [X]

Text

(Since 2.0.0) Tests if the text starts with the 'X' value supplied. Eg. "starts with Foo". This is case-sensitive.

ends with [X]

Text

(Since 2.0.0) Tests if the text ends with the 'X' value supplied. Eg. "ends with Bar". This is case-sensitive.

match [X]

Text

(Since 3.1.0) Tries to match the current complete text value with the specified regular expression. If successful, a Match is returned.

find [X]

Text

(Since 3.1.0) Tries to match a subset of the current text value with the specified regular expression. If there is more than one match in the text value, each will be an item in the returned list.

split with [X]

Text

List of Text

(Since 3.2.0) Splits the text value into chunks, divided by sub-text that matches the specified regular expression.

as number [X]

Text

(Since 3.2.0) Converts the text into a Number, using the provided format to parse it. If no format is provided it will try to parse it as a simple number.

as date [X]

Text

(Since 3.2.0) Tries to convert the text value into a Date based on the provided format.

is empty

Text

(Since 3.2.0) Is true if the text value has no characters.

is blank

Text

(Since 3.2.0) Is true if the text value is empty or all characters are white-space.