...
| Name | Description | Parameters | Return Type | Usage Example | |
|---|---|---|---|---|---|
| Append | Returns a new string with the specified string added to the end | string value | string | $Configuration.Name.Append(" ").Append($Build.Version$)$ | "Build Config 1.2.3" (given "Build Config", and "1.2.3") |
| Contains | boolean | ||||
| Insert | Returns a new string in which a specified string is inserted at a specified index position in the current text | integer startIndex, string value | string | ||
| Length | Returns the number of characters in the text | integer | |||
| PadLeft | Returns a new string that right-aligns the characters in the current text by padding them on the left with a specified character, for a specified total length | Stringstring | |||
| PadRight | Returns a new string that left-aligns the characters in the current text by padding them on the right with a specified character, for a specified total length | Stringstring | |||
| Remove | Returns a new string in which a specified number of characters in the current text beginning at a specified position have been deleted | Stringstring | |||
| Replace | Replaces all occurrences of the first specified string in the current string with the second specified string | Stringstring | $Configuration.Name.Replace("v.", "version" )$ | "Test Config version 10" (given "Test Config v. 10") | |
| Split | string array | ||||
| SplitWithQuotes | string array | ||||
| Substring | string | ||||
| ToBoolean | boolean | ||||
| ToLower | Converts a string to lowercase | Stringstring | $Source.RepoName.Branch.ToLower$ | "version 1.5" (given "Version 1.5") | |
| ToNumber | number | ||||
| ToUpper | Converts a string to uppercase | Stringstring | $Project.Name.ToUpper$ | "PROJECT X" (given "Project X") | |
| TrimStart | Stringstring | ||||
| Trim | Removes all leading and trailing occurrences of whitespace or the characters in the string provided | Stringstring | $Build.Version.Trim$ $Build.Version.Trim(".,")$ | "a b c d" (given " a b c d ") "a.b.c.d" (given ",a.b.c.d.") | |
| TrimEnd | Stringstring Contains | ||||
Number Functions
ToNumber
ToBoolean
Substring
Split
SplitWithQuotes
| Name |
|---|
| Description |
|---|
| Parameters |
|---|
| Return Type |
|---|
| Usage Examples | |||||
|---|---|---|---|---|---|
| Add | Adds the specified number to the current number and returns the result | number | |||
| Ceiling | Returns the smallest integer greater than or equal to the current decimal number | number | |||
| Decrement | Decrements the current number by one | number | |||
| Divide | Divides the current number by the specified number and returns the result | number | |||
| Floor | Returns the largest integer less than or equal to the current decimal number | integer | |||
| Increment | Increments the current number by one | number | |||
| IntegerDivide | Divides the current integer by the specified integer and returns an integer result | integer | |||
| Modulus | Returns the remainder after dividing the current number by the specified number | number | |||
| Multiply | Multiplies the current number by the specified number and returns the result | number | |||
| Round | Rounds the current decimal number to the nearest integer | integer | |||
| Subtract | Subtracts the specified number from the current number and returns the result | number | |||
| ToString | Parses current number to a string, allowing string operations and functions | string | |||
DateTime DateTime Functions
| Name | Description | Parameters | Return Type | Usage Examples | |
|---|---|---|---|---|---|
| Format | Formats a date or time value using standard or custom .Net formatting strings | String | $Server.Now.Format("hh:mm")$ | "23:55" (given the date time "31/12/2000 23:55:333") | |