String¶

String.Contains¶

Finds a substring inside an input string.

Overloads¶

String.Contains(String inputString, String searchString, Bool ignoreCase, ICultureAccessor cultureAccessor): Bool
String.Contains(String inputString, String searchString, Bool ignoreCase): Bool
String.Contains(String inputString, String searchString): Bool

cultureAccessor defaults to the culture defined in settings
ignoreCase defaults to false

Sample:

String word = "bed";
Bool containsCapitalE = String.Contains(word, "E");
Bool containsE = String.Contains(word, "e", false);

String.CreateFile¶

Creates a file with fileName containing content.

Overloads¶

String.CreateFile(String fileName, String content): File

Sample:

TextFile file = String.CreateFile("file.txt", "These are file contents");

String.Count¶

Counts the number of instances of a phrase. By default the search is case-sensitive.

Overloads¶

String.Count(String text, String searchPhrase): Int32
String.Count(String text, String searchPhrase, bool caseInsensitive): Int32

Sample:

Int32 count1 = String.Count("Banana | Oranges | Apple", "|"); // Returns 2
Int32 count2 = String.Count("Go go go go", "go"); // Returns 3
Int32 count3 = String.Count("Go go go go", "go", true); // Returns 4

String.SumDollar¶

Counts the dollar amount in the string

Overloads¶

String.SumDollar(String text): Double

Sample:

Double count1 = String.SumDollar("$50"); // Returns 50
Double count2 = String.SumDollar("BRAKE FLUID $50 | WIPERS $150"); // Returns 200

String.EndsWith¶

Returns true if the search string ends with the input string, otherwise returns false. If ignore case is set to true, then case differences are disregarded when comparing the strings.

Overloads¶

String.EndsWith(String inputString, String searchString, Bool ignoreCase, ICultureAccessor cultureAccessor): Bool
String.EndsWith(String inputString, String searchString, Bool ignoreCase): Bool
String.EndsWith(String inputString, String searchString): Bool

cultureAccessor defaults to the culture defined in settings
ignoreCase defaults to false

Sample:

String word = "apples";
Bool endsWithLowercaseS = String.EndsWith(word, "s");
Bool endsWithAnyS = String.EndsWith(word, "s", true);

String.IndexOf¶

Finds the zero-based starting index in the input string of the given substring searchString, provided the substring is part of the input string. If searchString is String.Empty, returns 0. If searchString is not in inputString, returns -1.

Overloads¶

String.IndexOf(String inputString, String searchString, Bool ignoreCase, ICultureAccessor cultureAccessor): Int
String.IndexOf(String inputString, String searchString, Bool ignoreCase): Int
String.IndexOf(String inputString, String searchString): Int

cultureAccessor defaults to the culture defined in settings
ignoreCase defaults to false

Sample:

String word = "apples";
Int32 whereIsL = String.IndexOf(word, "l");

String.Length¶

Returns the length of a string as an integer.

Overloads¶

String.Length(String str): Int

Sample:

String.Length("word") == 4;

String.LengthBetween¶

Returns true if string is between a specified minLength and maxLength range, otherwise false. Can specify inclusive or exclusive range.

Overloads¶

String.LengthBetween(String str, Int minLength, Int maxLength, Bool inclusive): Int**
String.LengthBetween(String str, Int minLength, Int maxLength): Int**

inclusive defaults to false
str cannot be null
minLength must be greater than or equal to 0
maxLength must be strictly greater than 0
maxLength must be strictly greater than minLength
if inclusive is false, returns true if str length is strictly greater than minLength and strictly less than maxLength
if inclusive is true, returns true if str length is greater than or equal to minLength and greater than or equal to maxLength

Sample:

record -> 'Name' : record['FirstName'] <- String.LengthBetween(record['FirstName'] to String, 2, 10), 'Sir/Madam'

String.IsEmpty¶

Returns true if input string is empty, otherwise false.

Overloads¶

String.Empty(String str): Bool

Sample:

String.IsEmpty("") == true;
String.IsEmpty(String.Empty) == true;
String.IsEmpty("string") == false;

String.IsNullOrEmpty¶

Returns true if input string is null or empty, otherwise false.

Overloads¶

String.IsNullOrEmpty(String str): Bool

Sample:

String.IsNullOrEmpty(null) == true;
String.IsNullOrEmpty("") == true;
String.IsNullOrEmpty(String.Empty) == true;
String.IsNullOrEmpty("string") == false;

String.IsNullOrWhiteSpace¶

Returns true if input string is null or entirely whitespace, otherwise false.

Overloads¶

String.IsNullOrWhitespace(String str): Bool

Sample:

String.IsNullOrWhitespace(null) == true;
String.IsNullOrWhitespace("        ") == true;
String.IsNullOrWhitespace("This is a sentence") == false;

String.Repeater¶

Takes a header, two lambda arguments repeated one after the other (alternating) records.Count() times, and a footer, concatenates them together and returns the resulting string.

Overloads¶

String.Repeater(Record[] records, String header, LambdaArgument item, LambdaArgument itemAlternative, LambdaArgument separator, String footer): String

Sample:

ForEach(records, record -> {

    Record[] clientRecords = dataRecords;

    String headerTemplate = @"<table><tr><th>Name</th></tr>";
    String invoiceDataHtml = String.Repeater(clientRecords, headerTemplate,
      record -> @"<tr><td class="odd">#{record.Name}</td></tr>",
      record -> @"<tr><td class="even">#{record.Name}</td></tr>",
      record -> String.Empty,
      '</table>');

String.Substring¶

Returns a substring of the first parameter based off the starting position (2nd parameter) and substring length (3rd parameter).

Overloads¶

String.Substring(String str, Int startSubstr, substrLength): String

Sample

String.Substring("0123456789", 2, 3)
// Output: "234"

None of the parameters can be null/empty
Index cannot be out of range
Length cannot exceed the length of the string

String.Replace¶

Searches the input string str for instances of the substring searchString, and replaces all of them with replacementString.

Overloads¶

String.Replace(String str, String searchString, String replacementString): String

None of str, searchString, and replacementString can be null
searchString cannot be an empty string

Sample:

String.Replace("I am very calm right now", "very calm", "nearly s****ing myself");

String.Split¶

Returns a string array containing substrings of the original string delimeted by specified delimeter.

Overloads¶

String.Split(String str, String delimeter): String[]

str cannot be null

Sample:

String[] stringArr = String.Split("This is a sentence.", " ");
stringArr[0] == "This";
stringArr[1] == "is";
stringArr[2] == "a";

String.StartsWith¶

Returns true if the search string begins with the input string, otherwise returns false. If ignore case is set to true, then case differences are disregarded when comparing the strings.

Overloads¶

String.StartsWith(String inputString, String searchString, Bool ignoreCase, ICultureAccessor cultureAccessor): Bool
String.StartsWith(String inputString, String searchString, Bool ignoreCase): Bool
String.StartsWith(String inputString, String searchString): Bool

cultureAccessor defaults to the culture defined in settings
ignoreCase defaults to false

Sample:

String word = "apples";
Bool startsWithLowercaseA = String.StartsWith(word, "a");
Bool startsWithAnyA = String.StartsWith(word, "a", true);

String.ToLower¶

Converts a STRING to all lowercase.

Overloads¶

String.ToLower(String str, ICultureAccessor cultureAccessor): String
String.ToLower(String str): String

cultureAccessor defaults to the culture defined in settings
throws an exception if str is null

Sample::: String.ToLower(“WORD”) == “word”;

String.ToProper¶

Converts a string to proper casing, i.e. converts first letter of each word to uppercase.

Overloads¶

String.ToProper(String str, ICultureAccessor cultureAccessor): String
String.ToProper(String str): String

cultureAccessor defaults to the culture defined in settings
throws an exception if str is null

Sample:

String.ToProper("mrs anderson") == "Mrs Anderson";

String.ToUpper¶

Converts a string to ALL UPPERCASE.

Overloads¶

String.ToUpper(String str, ICultureAccessor cultureAccessor): String
String.ToUpper(String str): String

cultureAccessor defaults to the culture defined in settings
throws an exception if str is null

Sample:

String.ToUpper("word") == "WORD";

String.ToSentenceCase¶

This allows us to upper case the first letter of a series of words.

Overloads¶

String.ToSentenceCase(String str): String

Sample:

String sentenceText = String.ToSentenceCase('hello this is some text');
Output: "Hello this is some text"

String.ToTitleCase¶

This allows us to title case (upper case every letter of each word)

Overloads¶

String.ToTitleCase(String Str): String

Sample:

String titleText = String.ToTitleCase('hello THIS iS sAmE TexT');
Output: "Hello This Is Same Text"

String.Trim¶

Removes all leading and trailing whitespace characters from a string.

Overloads¶

String.Trim(String str): String

Sample:

String.Trim("       space        ") == "space";