String

RTL2 String gives a unified interface on top of the platforms string type, ensuring all apis work the same on all platforms.

Creates a string with Value as content, in the encoding given in Encoding.

constructor(aBytes: array of Byte; aEncoding: Encoding := nil)

String(Byte[] aBytes, Encoding aEncoding = null)

init(_ aBytes: Byte..., _ aEncoding: Encoding = nil)

String(Byte[] aBytes, Encoding aEncoding)

Sub New(aBytes As Byte(), aEncoding As Encoding = Null)

Parameters:

aBytes:
aEncoding:

Creates a string with aChar repeated aCount times.

constructor(aChar: Char; aCount: Int32)

String(Char aChar, Int32 aCount)

init(_ aChar: Char, _ aCount: Int32)

String(Char aChar, Integer aCount)

Sub New(aChar As Char, aCount As Int32)

Parameters:

aChar:
aCount:

constructor (array of UnicodeCodePoint)

Creates a string with aCodePoints as content.

constructor(aCodePoints: array of UnicodeCodePoint)

String(UnicodeCodePoint[] aCodePoints)

init(_ aCodePoints: UnicodeCodePoint...)

String(UnicodeCodePoint[] aCodePoints)

Sub New(aCodePoints As UnicodeCodePoint())

Parameters:

aCodePoints:

constructor (List<NSNumber<UnicodeCodePoint>>) ToffeeV2

init(_ aCodePoints: List<NSNumber<UnicodeCodePoint>>)

Parameters:

aCodePoints:

Creates a string with aCodePoints as content.

constructor(aCodePoints: List<UnsignedInteger>)

String(List<UnsignedInteger> aCodePoints)

init(_ aCodePoints: List<UnsignedInteger>)

String(List<UnsignedInteger> aCodePoints)

Sub New(aCodePoints As List<UnsignedInteger>)

Parameters:

aCodePoints:

constructor (List<UnicodeCodePoint>) .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee

Creates a string with aCodePoints as content.

constructor(aCodePoints: List<UnicodeCodePoint>)

String(List<UnicodeCodePoint> aCodePoints)

init(_ aCodePoints: List<nullable UnicodeCodePoint>)

Sub New(aCodePoints As List<UnicodeCodePoint>)

Parameters:

aCodePoints:

constructor (array of Char)

Creates a string with Value as content.

constructor(Value: array of Char)

Parameters:

Value:

Creates a string with Value as content.

constructor(Value: array of Char; Offset: Int32; Count: Int32)

String(Char[] Value, Int32 Offset, Int32 Count)

init(_ Value: Char..., _ Offset: Int32, _ Count: Int32)

String(Char[] Value, Integer Offset, Integer Count)

Sub New(Value As Char(), Offset As Int32, Count As Int32)

Parameters:

Value:
Offset:
Count:

AppendPath

method AppendPath(params aPaths: array of String): nullable String

String? AppendPath(params String[] aPaths)

// Toffee
func AppendPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendPath(_ aPaths: String...) -> String?

String AppendPath(String[]... aPaths)

Function AppendPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

AppendUnixPath

method AppendUnixPath(params aPaths: array of String): nullable String

String? AppendUnixPath(params String[] aPaths)

// Toffee
func AppendUnixPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendUnixPath(_ aPaths: String...) -> String?

String AppendUnixPath(String[]... aPaths)

Function AppendUnixPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

AppendWindowsPath

method AppendWindowsPath(params aPaths: array of String): nullable String

String? AppendWindowsPath(params String[] aPaths)

// Toffee
func AppendWindowsPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendWindowsPath(_ aPaths: String...) -> String?

String AppendWindowsPath(String[]... aPaths)

Function AppendWindowsPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

Capitalize

Uppercase this with the default locale.

method Capitalize: not nullable String

func Capitalize() -> String

Function Capitalize() As String

Uppercase this with the given locale.

method Capitalize(aLocale: Locale): not nullable String

String! Capitalize(Locale aLocale)

func Capitalize(_ aLocale: Locale) -> String

String Capitalize(Locale aLocale)

Function Capitalize(aLocale As Locale) As String

Parameters:

aLocale:

CapitalizeInvariant

Uppercase this with the invariant locale.

method CapitalizeInvariant: not nullable String

String! CapitalizeInvariant()

func CapitalizeInvariant() -> String

String CapitalizeInvariant()

Function CapitalizeInvariant() As String

Chars

property Chars[aIndex: Index]: Char read;

Char Chars[Index aIndex] { get; }

subscript Chars(_ aIndex: Index) -> Char { get{} }

Char Chars[Index aIndex] { __get; }

ReadOnly Property Chars(aIndex As Index) As Char

Chars

Accessors for characters in the string

property Chars[aIndex: Int32]: Char read;

Char Chars[Int32 aIndex] { get; }

subscript Chars(_ aIndex: Int32) -> Char { get{} }

Char Chars[Integer aIndex] { __get; }

ReadOnly Property Chars(aIndex As Int32) As Char

Chars

property Chars[aRange: Range]: String read;

String Chars[Range aRange] { get; }

subscript Chars(_ aRange: Range) -> String { get{} }

String Chars[Range aRange] { __get; }

ReadOnly Property Chars(aRange As Range) As String

CollapseSpaces

method CollapseSpaces: String

func CollapseSpaces() -> String

Function CollapseSpaces() As String

Compare

Compare a string, returns 0 if the same, -1 if less, 1 if greater.

class method Compare(Value1: String; Value2: String): Int32

static Int32 Compare(String Value1, String Value2)

static func Compare(_ Value1: String, _ Value2: String) -> Int32

static Integer Compare(String Value1, String Value2)

Shared Function Compare(Value1 As String, Value2 As String) As Int32

Parameters:

Value1:
Value2:

CompareTo

compare this string to another string.

method CompareTo(Value: String): Int32

Int32 CompareTo(String Value)

func CompareTo(_ Value: String) -> Int32

Integer CompareTo(String Value)

Function CompareTo(Value As String) As Int32

Parameters:

Value:

CompareToIgnoreCase

Compare a string, case insensitive, returns 0 if the same, -1 if less, 1 if greater.

method CompareToIgnoreCase(Value: String): Int32

Int32 CompareToIgnoreCase(String Value)

func CompareToIgnoreCase(_ Value: String) -> Int32

Integer CompareToIgnoreCase(String Value)

Function CompareToIgnoreCase(Value As String) As Int32

Parameters:

Value:

Contains

Returns true if a string contains another string.

method Contains(Value: String): Boolean

Boolean Contains(String Value)

func Contains(_ Value: String) -> Boolean

Boolean Contains(String Value)

Function Contains(Value As String) As Boolean

Parameters:

Value:

Returns true if the string contains anf of the AnyOf characters.

method ContainsAny(AnyOf: array of Char): Boolean

Boolean ContainsAny(Char[] AnyOf)

func ContainsAny(_ AnyOf: Char...) -> Boolean

Boolean ContainsAny(Char[] AnyOf)

Function ContainsAny(AnyOf As Char()) As Boolean

Parameters:

AnyOf:

Returns true if the string contains anf of the AnyOf characters, starts from aStartIndex.

method ContainsAny(AnyOf: array of Char; aStartIndex: Int32): Boolean

Boolean ContainsAny(Char[] AnyOf, Int32 aStartIndex)

func ContainsAny(_ AnyOf: Char..., _ aStartIndex: Int32) -> Boolean

Boolean ContainsAny(Char[] AnyOf, Integer aStartIndex)

Function ContainsAny(AnyOf As Char(), aStartIndex As Int32) As Boolean

Parameters:

AnyOf:
aStartIndex:

ContainsAnyNonASCII

Returns true if the string contains an character > 127.

method ContainsAnyNonASCII: Boolean

Boolean ContainsAnyNonASCII()

func ContainsAnyNonASCII() -> Boolean

Boolean ContainsAnyNonASCII()

Function ContainsAnyNonASCII() As Boolean

Returns true if the string contains an character > 127, starts from aStartIndex.

method ContainsAnyNonASCII(aStartIndex: Int32): Boolean

Boolean ContainsAnyNonASCII(Int32 aStartIndex)

func ContainsAnyNonASCII(_ aStartIndex: Int32) -> Boolean

Boolean ContainsAnyNonASCII(Integer aStartIndex)

Function ContainsAnyNonASCII(aStartIndex As Int32) As Boolean

Parameters:

aStartIndex:

Returns true if the string contains only the AnyOf characters.

method ContainsOnly(AnyOf: array of Char): Boolean

Boolean ContainsOnly(Char[] AnyOf)

func ContainsOnly(_ AnyOf: Char...) -> Boolean

Boolean ContainsOnly(Char[] AnyOf)

Function ContainsOnly(AnyOf As Char()) As Boolean

Parameters:

AnyOf:

Returns true if the string contains only the AnyOf characters, starting at aStartIndex.

method ContainsOnly(AnyOf: array of Char; aStartIndex: Int32): Boolean

Boolean ContainsOnly(Char[] AnyOf, Int32 aStartIndex)

func ContainsOnly(_ AnyOf: Char..., _ aStartIndex: Int32) -> Boolean

Boolean ContainsOnly(Char[] AnyOf, Integer aStartIndex)

Function ContainsOnly(AnyOf As Char(), aStartIndex As Int32) As Boolean

Parameters:

AnyOf:
aStartIndex:

Empty

Empty string: ''

class property Empty: String read;

class String Empty { get; }

static var Empty: String { get{} }

class String Empty { __get; }

Shared ReadOnly Property Empty() As String

Returns true if a string ends with Value.

method EndsWith(Value: Char): Boolean

Boolean EndsWith(Char Value)

func EndsWith(_ Value: Char) -> Boolean

Boolean EndsWith(Char Value)

Function EndsWith(Value As Char) As Boolean

Parameters:

Value:

Returns true if a string ends with Value.

method EndsWith(Value: String): Boolean

Boolean EndsWith(String Value)

func EndsWith(_ Value: String) -> Boolean

Boolean EndsWith(String Value)

Function EndsWith(Value As String) As Boolean

Parameters:

Value:

Returns true if a string ends with Value.

method EndsWith(Value: String; IgnoreCase: Boolean): Boolean

Boolean EndsWith(String Value, Boolean IgnoreCase)

func EndsWith(_ Value: String, _ IgnoreCase: Boolean) -> Boolean

Boolean EndsWith(String Value, Boolean IgnoreCase)

Function EndsWith(Value As String, IgnoreCase As Boolean) As Boolean

Parameters:

Value:
IgnoreCase:

Returns true if these strings are exactly equivalent.

method Equals(Value: String): Boolean

Boolean Equals(String Value)

func Equals(_ Value: String) -> Boolean

Boolean Equals(String Value)

Function Equals(Value As String) As Boolean

Parameters:

Value:

Returns true if these strings are exactly equivalent.

class method Equals(ValueA: String; ValueB: String): Boolean

static Boolean Equals(String ValueA, String ValueB)

static func Equals(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean Equals(String ValueA, String ValueB)

Shared Function Equals(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

Returns true if these strings are equivalent, ignoring their case.

method EqualsIgnoringCase(Value: String): Boolean

Boolean EqualsIgnoringCase(String Value)

func EqualsIgnoringCase(_ Value: String) -> Boolean

Boolean EqualsIgnoringCase(String Value)

Function EqualsIgnoringCase(Value As String) As Boolean

Parameters:

Value:

Returns true if these strings are equivalent, ignoring their case.

class method EqualsIgnoringCase(ValueA: String; ValueB: String): Boolean

static Boolean EqualsIgnoringCase(String ValueA, String ValueB)

static func EqualsIgnoringCase(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean EqualsIgnoringCase(String ValueA, String ValueB)

Shared Function EqualsIgnoringCase(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

Returns true if these strings are equivalent, ignoring their case in the invariant culture.

method EqualsIgnoringCaseInvariant(Value: String): Boolean

Boolean EqualsIgnoringCaseInvariant(String Value)

func EqualsIgnoringCaseInvariant(_ Value: String) -> Boolean

Boolean EqualsIgnoringCaseInvariant(String Value)

Function EqualsIgnoringCaseInvariant(Value As String) As Boolean

Parameters:

Value:

Returns true if these strings are equivalent, ignoring their case in the invariant culture.

class method EqualsIgnoringCaseInvariant(ValueA: String; ValueB: String): Boolean

static Boolean EqualsIgnoringCaseInvariant(String ValueA, String ValueB)

static func EqualsIgnoringCaseInvariant(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean EqualsIgnoringCaseInvariant(String ValueA, String ValueB)

Shared Function EqualsIgnoringCaseInvariant(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

FileExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2

Returns true if this string points to a file that exists.

property FileExists: Boolean read;

Boolean FileExists { get; }

var FileExists: Boolean { get{} }

Boolean FileExists { __get; }

ReadOnly Property FileExists() As Boolean

FileOrFolderExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2

Returns true if this string points to a file or filder that exists.

property FileOrFolderExists: Boolean read;

Boolean FileOrFolderExists { get; }

var FileOrFolderExists: Boolean { get{} }

Boolean FileOrFolderExists { __get; }

ReadOnly Property FileOrFolderExists() As Boolean

FirstLine

Returns this string up to the first line ending, or everything.

property FirstLine: String read;

String FirstLine { get; }

var FirstLine: String { get{} }

String FirstLine { __get; }

ReadOnly Property FirstLine() As String

FolderExists .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2

Returns true if this string points to a folder that exists.

property FolderExists: Boolean read;

Boolean FolderExists { get; }

var FolderExists: Boolean { get{} }

Boolean FolderExists { __get; }

ReadOnly Property FolderExists() As Boolean

Format

Formats the string, uses .NET formatting style for aFormat.

class method Format(aFormat: String; params aParams: array of Object): not nullable String

static String! Format(String aFormat, params Object[] aParams)

static func Format(_ aFormat: String, _ aParams: Object...) -> String

static String Format(String aFormat, Object[]... aParams)

Shared Function Format(aFormat As String, ParamArray aParams As Object()) As String

Parameters:

aFormat:
aParams:

FuzzyMatches

Does a "fuzzy" match. Given the current string, ensures each character is in aHaystack in sequential order.

method FuzzyMatches(aHaystack: not nullable String): Boolean

Boolean FuzzyMatches(String! aHaystack)

func FuzzyMatches(_ aHaystack: String) -> Boolean

Boolean FuzzyMatches(String aHaystack)

Function FuzzyMatches(aHaystack As String) As Boolean

Parameters:

aHaystack:

GetSequence

Returns an iterator that yields each character in this string in order.

method GetSequence: IEnumerable<Char>

IEnumerable<Char> GetSequence()

// Toffee
func GetSequence() -> INSFastEnumeration<__ElementsBoxedChar>
// ToffeeV2
func GetSequence() -> IEnumerable<Char>

Iterable<Character> GetSequence()

Function GetSequence() As IEnumerable<Char>

IndexAfterJoinedUnicodeCharacterCoveringIndex

method IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex: Int32): Int32

Int32 IndexAfterJoinedUnicodeCharacterCoveringIndex(Int32 aIndex)

func IndexAfterJoinedUnicodeCharacterCoveringIndex(_ aIndex: Int32) -> Int32

Integer IndexAfterJoinedUnicodeCharacterCoveringIndex(Integer aIndex)

Function IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex As Int32) As Int32

Parameters:

aIndex:

Returns the index of Value in this string, returning -1 if it's not there.

method IndexOf(Value: Char): Int32

Int32 IndexOf(Char Value)

func IndexOf(_ Value: Char) -> Int32

Integer IndexOf(Char Value)

Function IndexOf(Value As Char) As Int32

Parameters:

Value:

Returns the index of Value in this string, start at StartIndex, returning -1 if it's not there.

method IndexOf(Value: Char; StartIndex: Int32): Int32

Int32 IndexOf(Char Value, Int32 StartIndex)

func IndexOf(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer IndexOf(Char Value, Integer StartIndex)

Function IndexOf(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of Value in this string, returning -1 if it's not there.

method IndexOf(Value: String): Int32

Int32 IndexOf(String Value)

func IndexOf(_ Value: String) -> Int32

Integer IndexOf(String Value)

Function IndexOf(Value As String) As Int32

Parameters:

Value:

Returns the index of Value in this string, start at StartIndex, returning -1 if it's not there.

method IndexOf(Value: String; StartIndex: Int32): Int32

Int32 IndexOf(String Value, Int32 StartIndex)

func IndexOf(_ Value: String, _ StartIndex: Int32) -> Int32

Integer IndexOf(String Value, Integer StartIndex)

Function IndexOf(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of any of these characters, or -1 if none can be found.

method IndexOfAny(AnyOf: array of Char): Int32

Int32 IndexOfAny(Char[] AnyOf)

func IndexOfAny(_ AnyOf: Char...) -> Int32

Integer IndexOfAny(Char[] AnyOf)

Function IndexOfAny(AnyOf As Char()) As Int32

Parameters:

AnyOf:

Returns the index of any of these characters, starting at StartIndex, or -1 if none can be found.

method IndexOfAny(AnyOf: array of Char; StartIndex: Int32): Int32

Int32 IndexOfAny(Char[] AnyOf, Int32 StartIndex)

func IndexOfAny(_ AnyOf: Char..., _ StartIndex: Int32) -> Int32

Integer IndexOfAny(Char[] AnyOf, Integer StartIndex)

Function IndexOfAny(AnyOf As Char(), StartIndex As Int32) As Int32

Parameters:

AnyOf:
StartIndex:

Returns the index of Value in this string, case insensitive, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: Char): Int32

Int32 IndexOfIgnoringCase(Char Value)

func IndexOfIgnoringCase(_ Value: Char) -> Int32

Integer IndexOfIgnoringCase(Char Value)

Function IndexOfIgnoringCase(Value As Char) As Int32

Parameters:

Value:

Returns the index of Value in this string, case insensitive, starting at StartIndex, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: Char; StartIndex: Int32): Int32

Int32 IndexOfIgnoringCase(Char Value, Int32 StartIndex)

func IndexOfIgnoringCase(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer IndexOfIgnoringCase(Char Value, Integer StartIndex)

Function IndexOfIgnoringCase(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of Value in this string, case insensitive, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: String): Int32

Int32 IndexOfIgnoringCase(String Value)

func IndexOfIgnoringCase(_ Value: String) -> Int32

Integer IndexOfIgnoringCase(String Value)

Function IndexOfIgnoringCase(Value As String) As Int32

Parameters:

Value:

Returns the index of Value in this string, case insensitive, starting at StartIndex, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: String; StartIndex: Int32): Int32

Int32 IndexOfIgnoringCase(String Value, Int32 StartIndex)

func IndexOfIgnoringCase(_ Value: String, _ StartIndex: Int32) -> Int32

Integer IndexOfIgnoringCase(String Value, Integer StartIndex)

Function IndexOfIgnoringCase(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

initialize ToffeeV2

Insert

Insert a string into this string, returning the new string.

method Insert(aIndex: Int32; aNewValue: String): not nullable String

String! Insert(Int32 aIndex, String aNewValue)

func Insert(_ aIndex: Int32, _ aNewValue: String) -> String

String Insert(Integer aIndex, String aNewValue)

Function Insert(aIndex As Int32, aNewValue As String) As String

Parameters:

aIndex:
aNewValue:

IsAbsolutePath

Returns true if this string points to an absolute path.

property IsAbsolutePath: Boolean read;

Boolean IsAbsolutePath { get; }

var IsAbsolutePath: Boolean { get{} }

Boolean IsAbsolutePath { __get; }

ReadOnly Property IsAbsolutePath() As Boolean

IsAbsoluteUnixPath

Returns true if this string points to an absolute unix path.

property IsAbsoluteUnixPath: Boolean read;

Boolean IsAbsoluteUnixPath { get; }

var IsAbsoluteUnixPath: Boolean { get{} }

Boolean IsAbsoluteUnixPath { __get; }

ReadOnly Property IsAbsoluteUnixPath() As Boolean

IsAbsoluteWindowsPath

Returns true if this string points to an absolute windows path.

property IsAbsoluteWindowsPath: Boolean read;

Boolean IsAbsoluteWindowsPath { get; }

var IsAbsoluteWindowsPath: Boolean { get{} }

Boolean IsAbsoluteWindowsPath { __get; }

ReadOnly Property IsAbsoluteWindowsPath() As Boolean

IsIndexInsideOfAJoinedUnicodeCharacter

method IsIndexInsideOfAJoinedUnicodeCharacter(aIndex: Int32): Boolean

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Int32 aIndex)

func IsIndexInsideOfAJoinedUnicodeCharacter(_ aIndex: Int32) -> Boolean

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Integer aIndex)

Function IsIndexInsideOfAJoinedUnicodeCharacter(aIndex As Int32) As Boolean

Parameters:

aIndex:

IsIndexInsideOfASurrogatePair

method IsIndexInsideOfASurrogatePair(aIndex: Int32): Boolean

Boolean IsIndexInsideOfASurrogatePair(Int32 aIndex)

func IsIndexInsideOfASurrogatePair(_ aIndex: Int32) -> Boolean

Boolean IsIndexInsideOfASurrogatePair(Integer aIndex)

Function IsIndexInsideOfASurrogatePair(aIndex As Int32) As Boolean

Parameters:

aIndex:

IsNullOrEmpty

Returns true if this string is null or empty.

class method IsNullOrEmpty(Value: String): Boolean

static Boolean IsNullOrEmpty(String Value)

static func IsNullOrEmpty(_ Value: String) -> Boolean

static Boolean IsNullOrEmpty(String Value)

Shared Function IsNullOrEmpty(Value As String) As Boolean

Parameters:

Value:

IsNullOrWhiteSpace

Returns true if this string is null, empty or jsut has whitespace.

class method IsNullOrWhiteSpace(Value: String): Boolean

static Boolean IsNullOrWhiteSpace(String Value)

static func IsNullOrWhiteSpace(_ Value: String) -> Boolean

static Boolean IsNullOrWhiteSpace(String Value)

Shared Function IsNullOrWhiteSpace(Value As String) As Boolean

Parameters:

Value:

IsWindowsPath

Returns true if this string is a valid windows path.

property IsWindowsPath: Boolean read;

Boolean IsWindowsPath { get; }

var IsWindowsPath: Boolean { get{} }

Boolean IsWindowsPath { __get; }

ReadOnly Property IsWindowsPath() As Boolean

Join (nullable String, not nullable array of String): not nullable String

Join a string together with aSeparator as separator.

class method Join(aSeparator: nullable String; Values: not nullable array of String): not nullable String

static String! Join(String? aSeparator, String[]! Values)

// Toffee
static func Join(_ aSeparator: String, _ Values: String...) -> String
// ToffeeV2
static func Join(_ aSeparator: String?, _ Values: String...) -> String

static String Join(String aSeparator, String[] Values)

Shared Function Join(aSeparator As String?, Values As String()) As String

Parameters:

aSeparator:
Values:

Join a string together with aSeparator as separator.

class method Join(aSeparator: nullable String; Values: not nullable ImmutableList<String>): not nullable String

static String! Join(String? aSeparator, ImmutableList<String>! Values)

// Toffee
static func Join(_ aSeparator: String, _ Values: ImmutableList<String>) -> String
// ToffeeV2
static func Join(_ aSeparator: String?, _ Values: ImmutableList<String>) -> String

static String Join(String aSeparator, ImmutableList<String> Values)

Shared Function Join(aSeparator As String?, Values As ImmutableList<String>) As String

Parameters:

aSeparator:
Values:

Returns the last index of Value in this string, returning -1 if it's not there.

method LastIndexOf(Value: Char): Int32

Int32 LastIndexOf(Char Value)

func LastIndexOf(_ Value: Char) -> Int32

Integer LastIndexOf(Char Value)

Function LastIndexOf(Value As Char) As Int32

Parameters:

Value:

Returns the last index of Value in this string, starting at StartIndex, returning -1 if it's not there.

method LastIndexOf(Value: Char; StartIndex: Int32): Int32

Int32 LastIndexOf(Char Value, Int32 StartIndex)

func LastIndexOf(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer LastIndexOf(Char Value, Integer StartIndex)

Function LastIndexOf(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the last index of Value in this string, returning -1 if it's not there.

method LastIndexOf(Value: String): Int32

Int32 LastIndexOf(String Value)

func LastIndexOf(_ Value: String) -> Int32

Integer LastIndexOf(String Value)

Function LastIndexOf(Value As String) As Int32

Parameters:

Value:

Returns the last index of Value in this string, starting at StartIndex, returning -1 if it's not there.

method LastIndexOf(Value: String; StartIndex: Int32): Int32

Int32 LastIndexOf(String Value, Int32 StartIndex)

func LastIndexOf(_ Value: String, _ StartIndex: Int32) -> Int32

Integer LastIndexOf(String Value, Integer StartIndex)

Function LastIndexOf(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

LastIndexOfAny (array of Char): Int32

Returns the last index of any of these characters, or -1 if none can be found.

method LastIndexOfAny(AnyOf: array of Char): Int32

Int32 LastIndexOfAny(Char[] AnyOf)

func LastIndexOfAny(_ AnyOf: Char...) -> Int32

Integer LastIndexOfAny(Char[] AnyOf)

Function LastIndexOfAny(AnyOf As Char()) As Int32

Parameters:

AnyOf:

Returns the last index of any of these characters, starting at StartIndex, or -1 if none can be found.

method LastIndexOfAny(AnyOf: array of Char; StartIndex: Int32): Int32

Int32 LastIndexOfAny(Char[] AnyOf, Int32 StartIndex)

func LastIndexOfAny(_ AnyOf: Char..., _ StartIndex: Int32) -> Int32

Integer LastIndexOfAny(Char[] AnyOf, Integer StartIndex)

Function LastIndexOfAny(AnyOf As Char(), StartIndex As Int32) As Int32

Parameters:

AnyOf:
StartIndex:

LastPathComponent

Returns the last component of this string, treating it as a path. Splits on the system directory seperator.

property LastPathComponent: String read;

String LastPathComponent { get; }

var LastPathComponent: String { get{} }

String LastPathComponent { __get; }

ReadOnly Property LastPathComponent() As String

LastPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the system directory seperator, ignoring the exception.

property LastPathComponentWithoutExtension: String read;

String LastPathComponentWithoutExtension { get; }

var LastPathComponentWithoutExtension: String { get{} }

String LastPathComponentWithoutExtension { __get; }

ReadOnly Property LastPathComponentWithoutExtension() As String

LastUnixPathComponent

Returns the last component of this string, treating it as a path. Splits on the unix directory seperator.

property LastUnixPathComponent: String read;

String LastUnixPathComponent { get; }

var LastUnixPathComponent: String { get{} }

String LastUnixPathComponent { __get; }

ReadOnly Property LastUnixPathComponent() As String

LastUnixPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the unix directory seperator, ignoring the extension.

property LastUnixPathComponentWithoutExtension: String read;

String LastUnixPathComponentWithoutExtension { get; }

var LastUnixPathComponentWithoutExtension: String { get{} }

String LastUnixPathComponentWithoutExtension { __get; }

ReadOnly Property LastUnixPathComponentWithoutExtension() As String

LastWindowsPathComponent

Returns the last component of this string, treating it as a path. Splits on the windows directory seperator.

property LastWindowsPathComponent: String read;

String LastWindowsPathComponent { get; }

var LastWindowsPathComponent: String { get{} }

String LastWindowsPathComponent { __get; }

ReadOnly Property LastWindowsPathComponent() As String

LastWindowsPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the windows directory seperator, ignoring the exxception.

property LastWindowsPathComponentWithoutExtension: String read;

String LastWindowsPathComponentWithoutExtension { get; }

var LastWindowsPathComponentWithoutExtension: String { get{} }

String LastWindowsPathComponentWithoutExtension { __get; }

ReadOnly Property LastWindowsPathComponentWithoutExtension() As String

Length

Returns the length of this string.

property Length: Int32 read;

var Length: Int32 { get{} }

Integer Length { __get; }

ReadOnly Property Length() As Int32

LevenshteinDistanceTo

Returns the levenshtein distance to another string, essentially returns the number of differences between these strings, returning the nr of inserts, deletions and replacements.

method LevenshteinDistanceTo(aOther: not nullable String): Int32

Int32 LevenshteinDistanceTo(String! aOther)

func LevenshteinDistanceTo(_ aOther: String) -> Int32

Integer LevenshteinDistanceTo(String aOther)

Function LevenshteinDistanceTo(aOther As String) As Int32

Parameters:

aOther:

NetworkServerName

Returns the network server name from a path string.

property NetworkServerName: nullable String read;

String? NetworkServerName { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var NetworkServerName: String? { get{} }
// Toffee
var NetworkServerName: String { get{} }

String NetworkServerName { __get; }

ReadOnly Property NetworkServerName() As String?

Pads the string so it's at least total width, with whitespaces.

method PadEnd(TotalWidth: Int32): not nullable String

String! PadEnd(Int32 TotalWidth)

func PadEnd(_ TotalWidth: Int32) -> String

String PadEnd(Integer TotalWidth)

Function PadEnd(TotalWidth As Int32) As String

Parameters:

TotalWidth:

Pads the string so it's at least total width, with padding characters.

method PadEnd(TotalWidth: Int32; PaddingChar: Char): not nullable String

String! PadEnd(Int32 TotalWidth, Char PaddingChar)

func PadEnd(_ TotalWidth: Int32, _ PaddingChar: Char) -> String

String PadEnd(Integer TotalWidth, Char PaddingChar)

Function PadEnd(TotalWidth As Int32, PaddingChar As Char) As String

Parameters:

TotalWidth:
PaddingChar:

Pads the string so it's at least total width, with whitespaces.

method PadStart(TotalWidth: Int32): not nullable String

String! PadStart(Int32 TotalWidth)

func PadStart(_ TotalWidth: Int32) -> String

String PadStart(Integer TotalWidth)

Function PadStart(TotalWidth As Int32) As String

Parameters:

TotalWidth:

Pads the string so it's at least total width, with padding characters.

method PadStart(TotalWidth: Int32; PaddingChar: Char): not nullable String

String! PadStart(Int32 TotalWidth, Char PaddingChar)

func PadStart(_ TotalWidth: Int32, _ PaddingChar: Char) -> String

String PadStart(Integer TotalWidth, Char PaddingChar)

Function PadStart(TotalWidth As Int32, PaddingChar As Char) As String

Parameters:

TotalWidth:
PaddingChar:

ParentDirectory

property ParentDirectory: nullable String read;

String? ParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ParentDirectory: String? { get{} }
// Toffee
var ParentDirectory: String { get{} }

String ParentDirectory { __get; }

ReadOnly Property ParentDirectory() As String?

PathExtension

Returns the extension of this string, treating it as filename.

property PathExtension: String read;

String PathExtension { get; }

var PathExtension: String { get{} }

String PathExtension { __get; }

ReadOnly Property PathExtension() As String

PathWithoutExtension

Returns this string without extension, treating it as filename.

property PathWithoutExtension: String read;

String PathWithoutExtension { get; }

var PathWithoutExtension: String { get{} }

String PathWithoutExtension { __get; }

ReadOnly Property PathWithoutExtension() As String

Plural

method Plural(aCount: Int32; aPluralVersion: not nullable String): not nullable String

String! Plural(Int32 aCount, String! aPluralVersion)

func Plural(_ aCount: Int32, _ aPluralVersion: String) -> String

String Plural(Integer aCount, String aPluralVersion)

Function Plural(aCount As Int32, aPluralVersion As String) As String

Parameters:

aCount:
aPluralVersion:

PluralInvariant

method PluralInvariant(aCount: Int32; aPluralVersion: nullable String := nil): not nullable String

String! PluralInvariant(Int32 aCount, String? aPluralVersion = null)

// Toffee
func PluralInvariant(_ aCount: Int32, _ aPluralVersion: String = nil) -> String
// ToffeeV2
func PluralInvariant(_ aCount: Int32, _ aPluralVersion: String? = nil) -> String

String PluralInvariant(Integer aCount, String aPluralVersion)

Function PluralInvariant(aCount As Int32, aPluralVersion As String? = Null) As String

Parameters:

aCount:
aPluralVersion:

method ProcessVariables(aStyle: VariableStyle; aCallback: Func<not nullable String, wrapped nullable String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Func<not nullable String, wrapped nullable String> aCallback)

// Toffee
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String) -> String) -> String
// ToffeeV2
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String) -> String?) -> String

String ProcessVariables(VariableStyle aStyle, Func2<String, String> aCallback)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func (Of String, String?)) As String
// Island
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func<not nullable String, wrapped nullable String>) As String

Parameters:

aStyle:
aCallback:

method ProcessVariables(aStyle: VariableStyle; aCallback: Func<not nullable String, VariableStatus, wrapped nullable String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Func<not nullable String, VariableStatus, wrapped nullable String> aCallback)

// Toffee
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String, VariableStatus) -> String) -> String
// ToffeeV2
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String, VariableStatus) -> String?) -> String

String ProcessVariables(VariableStyle aStyle, Func3<String, VariableStatus, String> aCallback)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func (Of String, VariableStatus, String?)) As String
// Island
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func<not nullable String, VariableStatus, wrapped nullable String>) As String

Parameters:

aStyle:
aCallback:

method ProcessVariables(aStyle: VariableStyle; aValues: Dictionary<String, String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Dictionary<String, String> aValues)

func ProcessVariables(_ aStyle: VariableStyle, _ aValues: Dictionary<String, String>) -> String

String ProcessVariables(VariableStyle aStyle, Dictionary<String, String> aValues)

Function ProcessVariables(aStyle As VariableStyle, aValues As Dictionary<String, String>) As String

Parameters:

aStyle:
aValues:

QuotedIfNeeded

Adds quotes if this string contains whitespace.

property QuotedIfNeeded: String read;

String QuotedIfNeeded { get; }

var QuotedIfNeeded: String { get{} }

String QuotedIfNeeded { __get; }

ReadOnly Property QuotedIfNeeded() As String

Removes a range from this string, returning the new stirng.

method Remove(aStartIndex: Int32; aLength: Int32): not nullable String

String! Remove(Int32 aStartIndex, Int32 aLength)

func Remove(_ aStartIndex: Int32, _ aLength: Int32) -> String

String Remove(Integer aStartIndex, Integer aLength)

Function Remove(aStartIndex As Int32, aLength As Int32) As String

Parameters:

aStartIndex:
aLength:

Removes a range from this string, returning the new stirng.

method Remove(OldValue: String): not nullable String

String! Remove(String OldValue)

func Remove(_ OldValue: String) -> String

String Remove(String OldValue)

Function Remove(OldValue As String) As String

Parameters:

OldValue:

Replace a range in this string with new substring.

method Replace(aStartIndex: Int32; aLength: Int32; aNewValue: String): not nullable String

String! Replace(Int32 aStartIndex, Int32 aLength, String aNewValue)

func Replace(_ aStartIndex: Int32, _ aLength: Int32, _ aNewValue: String) -> String

String Replace(Integer aStartIndex, Integer aLength, String aNewValue)

Function Replace(aStartIndex As Int32, aLength As Int32, aNewValue As String) As String

Parameters:

aStartIndex:
aLength:
aNewValue:

Replace all occurances of a string with another value.

method Replace(OldValue: String; NewValue: String): not nullable String

String! Replace(String OldValue, String NewValue)

func Replace(_ OldValue: String, _ NewValue: String) -> String

String Replace(String OldValue, String NewValue)

Function Replace(OldValue As String, NewValue As String) As String

Parameters:

OldValue:
NewValue:

SmartJoin

class method SmartJoin(aStringA: nullable String; aStringB: nullable String) WithSeparator(aSeparator: not nullable String): nullable String

static String? SmartJoin(String? aStringA, String? aStringB) WithSeparator(String! aSeparator)

// Toffee
static func SmartJoin(_ aStringA: String, _ aStringB: String, WithSeparator aSeparator: String) -> String
// ToffeeV2
static func SmartJoin(_ aStringA: String?, _ aStringB: String?, WithSeparator aSeparator: String) -> String?

static String SmartJoin(String aStringA, String aStringB) WithSeparator(String aSeparator)

Shared Function SmartJoin(aStringA As String?, aStringB As String?) WithSeparator(aSeparator As String) As String?

Parameters:

aStringA:
aStringB:
aSeparator:

Split

Split this string on aSeparator.

method Split(aSeparator: not nullable String; aRemoveEmptyEntries: Boolean := false): not nullable ImmutableList<String>

ImmutableList<String>! Split(String! aSeparator, Boolean aRemoveEmptyEntries = false)

func Split(_ aSeparator: String, _ aRemoveEmptyEntries: Boolean = false) -> ImmutableList<String>

ImmutableList<String> Split(String aSeparator, Boolean aRemoveEmptyEntries)

Function Split(aSeparator As String, aRemoveEmptyEntries As Boolean = false) As ImmutableList<String>

Parameters:

aSeparator:
aRemoveEmptyEntries:

SplitAtFirstOccurrenceOf

Split this string but at most once at the first occurance of aSeperator.

method SplitAtFirstOccurrenceOf(aSeparator: not nullable String): not nullable ImmutableList<String>

ImmutableList<String>! SplitAtFirstOccurrenceOf(String! aSeparator)

func SplitAtFirstOccurrenceOf(_ aSeparator: String) -> ImmutableList<String>

ImmutableList<String> SplitAtFirstOccurrenceOf(String aSeparator)

Function SplitAtFirstOccurrenceOf(aSeparator As String) As ImmutableList<String>

Parameters:

aSeparator:

SplitAtLastOccurrenceOf

Split this string but at most once at the last occurance of aSeperator.

method SplitAtLastOccurrenceOf(aSeparator: not nullable String): not nullable ImmutableList<String>

ImmutableList<String>! SplitAtLastOccurrenceOf(String! aSeparator)

func SplitAtLastOccurrenceOf(_ aSeparator: String) -> ImmutableList<String>

ImmutableList<String> SplitAtLastOccurrenceOf(String aSeparator)

Function SplitAtLastOccurrenceOf(aSeparator As String) As ImmutableList<String>

Parameters:

aSeparator:

StartIndexOfJoinedUnicodeCharacterAtIndex

method StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex: Int32): Int32

Int32 StartIndexOfJoinedUnicodeCharacterAtIndex(Int32 aIndex)

func StartIndexOfJoinedUnicodeCharacterAtIndex(_ aIndex: Int32) -> Int32

Integer StartIndexOfJoinedUnicodeCharacterAtIndex(Integer aIndex)

Function StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex As Int32) As Int32

Parameters:

aIndex:

True if this string starts with Value

method StartsWith(Value: Char): Boolean

Boolean StartsWith(Char Value)

func StartsWith(_ Value: Char) -> Boolean

Boolean StartsWith(Char Value)

Function StartsWith(Value As Char) As Boolean

Parameters:

Value:

True if this string starts with Value

method StartsWith(Value: String): Boolean

Boolean StartsWith(String Value)

func StartsWith(_ Value: String) -> Boolean

Boolean StartsWith(String Value)

Function StartsWith(Value As String) As Boolean

Parameters:

Value:

True if this string starts with Value

method StartsWith(Value: String; IgnoreCase: Boolean): Boolean

Boolean StartsWith(String Value, Boolean IgnoreCase)

func StartsWith(_ Value: String, _ IgnoreCase: Boolean) -> Boolean

Boolean StartsWith(String Value, Boolean IgnoreCase)

Function StartsWith(Value As String, IgnoreCase As Boolean) As Boolean

Parameters:

Value:
IgnoreCase:

method Substring(aRange: Range): not nullable String

String! Substring(Range aRange)

func Substring(_ aRange: Range) -> String

String Substring(Range aRange)

Function Substring(aRange As Range) As String

Parameters:

aRange:

Returns a substring of this string, starting at StartIndex.

method Substring(StartIndex: Int32): not nullable String

String! Substring(Int32 StartIndex)

func Substring(_ StartIndex: Int32) -> String

String Substring(Integer StartIndex)

Function Substring(StartIndex As Int32) As String

Parameters:

StartIndex:

Returns a substring from StartIndex for aLength of this string.

method Substring(StartIndex: Int32; aLength: Int32): not nullable String

String! Substring(Int32 StartIndex, Int32 aLength)

func Substring(_ StartIndex: Int32, _ aLength: Int32) -> String

String Substring(Integer StartIndex, Integer aLength)

Function Substring(StartIndex As Int32, aLength As Int32) As String

Parameters:

StartIndex:
aLength:

SubstringFromFirstOccurrenceOf

Returns a substring of this string, starting at the first occurance of aSeperator.

method SubstringFromFirstOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringFromFirstOccurrenceOf(String! aSeparator)

func SubstringFromFirstOccurrenceOf(_ aSeparator: String) -> String

String SubstringFromFirstOccurrenceOf(String aSeparator)

Function SubstringFromFirstOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringFromLastOccurrenceOf

Returns a substring of this string, starting at the last occurance of aSeperator.

method SubstringFromLastOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringFromLastOccurrenceOf(String! aSeparator)

func SubstringFromLastOccurrenceOf(_ aSeparator: String) -> String

String SubstringFromLastOccurrenceOf(String aSeparator)

Function SubstringFromLastOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringToFirstOccurrenceOf

Returns a substring of this string, stopping at the first occurance of aSeperator.

method SubstringToFirstOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringToFirstOccurrenceOf(String! aSeparator)

func SubstringToFirstOccurrenceOf(_ aSeparator: String) -> String

String SubstringToFirstOccurrenceOf(String aSeparator)

Function SubstringToFirstOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringToLastOccurrenceOf

Returns a substring of this string, stopping at the last occurance of aSeperator.

method SubstringToLastOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringToLastOccurrenceOf(String! aSeparator)

func SubstringToLastOccurrenceOf(_ aSeparator: String) -> String

String SubstringToLastOccurrenceOf(String aSeparator)

Function SubstringToLastOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

ToByteArray

Converts this string to utf8.

method ToByteArray: not nullable array of Byte

func ToByteArray() -> Byte...

Function ToByteArray() As Byte()

ToByteArray (not nullable Encoding): not nullable array of Byte

Convert this string to the given encoding.

method ToByteArray(aEncoding: not nullable Encoding): not nullable array of Byte

Byte[]! ToByteArray(Encoding! aEncoding)

func ToByteArray(_ aEncoding: Encoding) -> Byte...

Byte[] ToByteArray(Encoding aEncoding)

Function ToByteArray(aEncoding As Encoding) As Byte()

Parameters:

aEncoding:

ToCharArray

Convert this string to an array.

method ToCharArray: not nullable array of Char

func ToCharArray() -> Char...

Function ToCharArray() As Char()

ToHexString

Convert this string to he.x

method ToHexString: String

func ToHexString() -> String

Function ToHexString() As String

ToLower

Lowrcase this string in the default locale.

method ToLower: not nullable String

Function ToLower() As String

Lowrcase this string in the given locale.

method ToLower(aLocale: Locale): not nullable String

String! ToLower(Locale aLocale)

func ToLower(_ aLocale: Locale) -> String

String ToLower(Locale aLocale)

Function ToLower(aLocale As Locale) As String

Parameters:

aLocale:

ToLowerInvariant

Lowrcase this string in the invariant locale.

method ToLowerInvariant: not nullable String

String! ToLowerInvariant()

func ToLowerInvariant() -> String

String ToLowerInvariant()

Function ToLowerInvariant() As String

ToPathRelativeToFolder (not nullable String) Always(Boolean): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String) Always(aAlways: Boolean): nullable String

String? ToPathRelativeToFolder(String! aBasePath) Always(Boolean aAlways)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String, Always aAlways: Boolean) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String, Always aAlways: Boolean) -> String?

String ToPathRelativeToFolder(String aBasePath) Always(Boolean aAlways)

Function ToPathRelativeToFolder(aBasePath As String) Always(aAlways As Boolean) As String?

Parameters:

aBasePath:
aAlways:

ToPathRelativeToFolder (not nullable String) Threshold(Int32): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String) Threshold(aThreshold: Int32): nullable String

String? ToPathRelativeToFolder(String! aBasePath) Threshold(Int32 aThreshold)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String, Threshold aThreshold: Int32) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String, Threshold aThreshold: Int32) -> String?

String ToPathRelativeToFolder(String aBasePath) Threshold(Integer aThreshold)

Function ToPathRelativeToFolder(aBasePath As String) Threshold(aThreshold As Int32) As String?

Parameters:

aBasePath:
aThreshold:

ToPathRelativeToFolder (not nullable String): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String): nullable String

String? ToPathRelativeToFolder(String! aBasePath)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String) -> String?

String ToPathRelativeToFolder(String aBasePath)

Function ToPathRelativeToFolder(aBasePath As String) As String?

Parameters:

aBasePath:

ToPathWithLocalFolderPrefixIfRelative

Adds a ./ or .\ if this is a relative path.

property ToPathWithLocalFolderPrefixIfRelative: String read;

String ToPathWithLocalFolderPrefixIfRelative { get; }

var ToPathWithLocalFolderPrefixIfRelative: String { get{} }

String ToPathWithLocalFolderPrefixIfRelative { __get; }

ReadOnly Property ToPathWithLocalFolderPrefixIfRelative() As String

ToPlatformPathFromUnixPath

Converts a unix path to the system path format (does nothing on Unix).

property ToPlatformPathFromUnixPath: String read;

String ToPlatformPathFromUnixPath { get; }

var ToPlatformPathFromUnixPath: String { get{} }

String ToPlatformPathFromUnixPath { __get; }

ReadOnly Property ToPlatformPathFromUnixPath() As String

ToPlatformPathFromWindowsPath

Converts a windows path to the system path format (does nothing on Unix).

property ToPlatformPathFromWindowsPath: String read;

String ToPlatformPathFromWindowsPath { get; }

var ToPlatformPathFromWindowsPath: String { get{} }

String ToPlatformPathFromWindowsPath { __get; }

ReadOnly Property ToPlatformPathFromWindowsPath() As String

ToUnicodeCharacters

Convert this string to utf32 unicode characters.

method ToUnicodeCharacters: ImmutableList<UnicodeCharacter>

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

func ToUnicodeCharacters() -> ImmutableList<UnicodeCharacter>

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

Function ToUnicodeCharacters() As ImmutableList<UnicodeCharacter>

ToUnicodeCodePointIndices

Convert this string to utf32 unicode characters.

method ToUnicodeCodePointIndices: ImmutableList<Int32>

ImmutableList<Int32> ToUnicodeCodePointIndices()

// Toffee
func ToUnicodeCodePointIndices() -> ImmutableList<nullable Int32>
// ToffeeV2
func ToUnicodeCodePointIndices() -> ImmutableList<NSNumber<Int32>>

ImmutableList<Integer> ToUnicodeCodePointIndices()

Function ToUnicodeCodePointIndices() As ImmutableList<Int32>

ToUnicodeCodePoints

Convert this string to utf32 unicode characters.

method ToUnicodeCodePoints: ImmutableList<UnicodeCodePoint>

ImmutableList<UnicodeCodePoint> ToUnicodeCodePoints()

// Toffee
func ToUnicodeCodePoints() -> ImmutableList<nullable UnicodeCodePoint>
// ToffeeV2
func ToUnicodeCodePoints() -> ImmutableList<NSNumber<UnicodeCodePoint>>

ImmutableList<UnsignedInteger> ToUnicodeCodePoints()

Function ToUnicodeCodePoints() As ImmutableList<UnicodeCodePoint>

ToUnixPath

Convert this to a unix path.

property ToUnixPath: String read;

String ToUnixPath { get; }

var ToUnixPath: String { get{} }

String ToUnixPath { __get; }

ReadOnly Property ToUnixPath() As String

ToUnixPathFromWindowsPath

Convert a Windows path to unix path.

property ToUnixPathFromWindowsPath: String read;

String ToUnixPathFromWindowsPath { get; }

var ToUnixPathFromWindowsPath: String { get{} }

String ToUnixPathFromWindowsPath { __get; }

ReadOnly Property ToUnixPathFromWindowsPath() As String

ToUpper

Uppercase this string in the default locale.

method ToUpper: not nullable String

Function ToUpper() As String

Uppercase this string in the given locale.

method ToUpper(aLocale: Locale): not nullable String

String! ToUpper(Locale aLocale)

func ToUpper(_ aLocale: Locale) -> String

String ToUpper(Locale aLocale)

Function ToUpper(aLocale As Locale) As String

Parameters:

aLocale:

ToUpperInvariant

Uppercase this string in the invariant locale.

method ToUpperInvariant: not nullable String

String! ToUpperInvariant()

func ToUpperInvariant() -> String

String ToUpperInvariant()

Function ToUpperInvariant() As String

ToWindowsPath

Convert to a Windows path.

property ToWindowsPath: String read;

String ToWindowsPath { get; }

var ToWindowsPath: String { get{} }

String ToWindowsPath { __get; }

ReadOnly Property ToWindowsPath() As String

ToWindowsPathFromUnixPath

Convert a unix path to a Windows path.

property ToWindowsPathFromUnixPath: String read;

String ToWindowsPathFromUnixPath { get; }

var ToWindowsPathFromUnixPath: String { get{} }

String ToWindowsPathFromUnixPath { __get; }

ReadOnly Property ToWindowsPathFromUnixPath() As String

Trim

Trim this string, on both ends with all unicode whitespace characters.

method Trim: not nullable String

Function Trim() As String

Trim (array of Char): not nullable String

Trim this string, on both ends with the given characters.

method Trim(params TrimChars: array of Char): not nullable String

String! Trim(params Char[] TrimChars)

func Trim(_ TrimChars: Char...) -> String

String Trim(Char[]... TrimChars)

Function Trim(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

TrimEnd

Trim this string, at the end with all unicode whitespace characters.

method TrimEnd: not nullable String

Function TrimEnd() As String

TrimEnd (array of Char): not nullable String

Trim this string, at the end with the given characters.

method TrimEnd(params TrimChars: array of Char): not nullable String

String! TrimEnd(params Char[] TrimChars)

func TrimEnd(_ TrimChars: Char...) -> String

String TrimEnd(Char[]... TrimChars)

Function TrimEnd(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

TrimNewLineCharacters

Removes newline characters at the end/start of the string.

method TrimNewLineCharacters: not nullable String

String! TrimNewLineCharacters()

func TrimNewLineCharacters() -> String

String TrimNewLineCharacters()

Function TrimNewLineCharacters() As String

TrimStart

Trim this string, at the start with all unicode whitespace characters.

method TrimStart: not nullable String

func TrimStart() -> String

Function TrimStart() As String

TrimStart (array of Char): not nullable String

Trim this string, at the start with the given characters.

method TrimStart(params TrimChars: array of Char): not nullable String

String! TrimStart(params Char[] TrimChars)

func TrimStart(_ TrimChars: Char...) -> String

String TrimStart(Char[]... TrimChars)

Function TrimStart(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

Truncate

method Truncate(aLength: Int32; aEllipsis: String := '…'; aStyle: StringTruncationStyle := StringTruncationStyle.End): String

String Truncate(Int32 aLength, String aEllipsis = \"…\", StringTruncationStyle aStyle = StringTruncationStyle.End)

func Truncate(_ aLength: Int32, _ aEllipsis: String = \"…\", _ aStyle: StringTruncationStyle = StringTruncationStyle.End) -> String

String Truncate(Integer aLength, String aEllipsis, StringTruncationStyle aStyle)

Function Truncate(aLength As Int32, aEllipsis As String = \"…\", aStyle As StringTruncationStyle = StringTruncationStyle.End) As String

Parameters:

aLength:
aEllipsis:
aStyle:

UnicodeCodePointAtIndex

Returns the unicode code point at a given index.

method UnicodeCodePointAtIndex(aIndex: Int32): UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointAtIndex(Int32 aIndex)

func UnicodeCodePointAtIndex(_ aIndex: Int32) -> UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointAtIndex(Integer aIndex)

Function UnicodeCodePointAtIndex(aIndex As Int32) As UnicodeCodePoint

Parameters:

aIndex:

UnicodeCodePointBeforeIndex

Returns the unicode code point before a given index.

method UnicodeCodePointBeforeIndex(aIndex: Int32): UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointBeforeIndex(Int32 aIndex)

func UnicodeCodePointBeforeIndex(_ aIndex: Int32) -> UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointBeforeIndex(Integer aIndex)

Function UnicodeCodePointBeforeIndex(aIndex As Int32) As UnicodeCodePoint

Parameters:

aIndex:

method Unique(aValidator: not nullable Func<String, Boolean>; aStartIndex: Int32 := 2; aApplyPattern: Func<Int32, String>): String

String Unique(Func<String, Boolean>! aValidator, Int32 aStartIndex = 2, Func<Int32, String> aApplyPattern)

func Unique(_ aValidator: (String) -> Boolean, _ aStartIndex: Int32 = 2, _ aApplyPattern: (Int32) -> String) -> String

String Unique(Func2<String, Boolean> aValidator, Integer aStartIndex, Func2<Integer, String> aApplyPattern)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aApplyPattern As Func (Of Int32, String)) As String
// Island
Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aApplyPattern As Func<Int32, String>) As String

Parameters:

aValidator:
aStartIndex:
aApplyPattern:

method Unique(aValidator: not nullable Func<String, Boolean>; aStartIndex: Int32 := 2; aPattern: not nullable String := ' {0}'): String

String Unique(Func<String, Boolean>! aValidator, Int32 aStartIndex = 2, String! aPattern = \" {0}\")

func Unique(_ aValidator: (String) -> Boolean, _ aStartIndex: Int32 = 2, _ aPattern: String = \" {0}\") -> String

String Unique(Func2<String, Boolean> aValidator, Integer aStartIndex, String aPattern)

Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aPattern As String = \" {0}\") As String

Parameters:

aValidator:
aStartIndex:
aPattern:

UniqueFilePath .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island-Android, Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-Ubuntu, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32, Island-Windows, Toffee, ToffeeV2

method UniqueFilePath(aStartIndex: Int32 := 2; aPattern: String := ' {0}'): String

String UniqueFilePath(Int32 aStartIndex = 2, String aPattern = \" {0}\")

func UniqueFilePath(_ aStartIndex: Int32 = 2, _ aPattern: String = \" {0}\") -> String

String UniqueFilePath(Integer aStartIndex, String aPattern)

Function UniqueFilePath(aStartIndex As Int32 = 2, aPattern As String = \" {0}\") As String

Parameters:

aStartIndex:
aPattern:

UnixParentDirectory

property UnixParentDirectory: nullable String read;

String? UnixParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var UnixParentDirectory: String? { get{} }
// Toffee
var UnixParentDirectory: String { get{} }

String UnixParentDirectory { __get; }

ReadOnly Property UnixParentDirectory() As String?

WhiteSpaceCharacters

List of whitespace characters.

class var WhiteSpaceCharacters: array of Char;

static Char[] WhiteSpaceCharacters

static var WhiteSpaceCharacters: Char...

static Char[] WhiteSpaceCharacters

Shared FIELD WhiteSpaceCharacters() As Char()

WindowsParentDirectory

property WindowsParentDirectory: nullable String read;

String? WindowsParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var WindowsParentDirectory: String? { get{} }
// Toffee
var WindowsParentDirectory: String { get{} }

String WindowsParentDirectory { __get; }

ReadOnly Property WindowsParentDirectory() As String?

WhiteSpaceCharacters

List of whitespace characters.

class var WhiteSpaceCharacters: array of Char;

static Char[] WhiteSpaceCharacters

static var WhiteSpaceCharacters: Char...

static Char[] WhiteSpaceCharacters

Shared FIELD WhiteSpaceCharacters() As Char()

Chars

property Chars[aIndex: Index]: Char read;

Char Chars[Index aIndex] { get; }

subscript Chars(_ aIndex: Index) -> Char { get{} }

Char Chars[Index aIndex] { __get; }

ReadOnly Property Chars(aIndex As Index) As Char

Chars

Accessors for characters in the string

property Chars[aIndex: Int32]: Char read;

Char Chars[Int32 aIndex] { get; }

subscript Chars(_ aIndex: Int32) -> Char { get{} }

Char Chars[Integer aIndex] { __get; }

ReadOnly Property Chars(aIndex As Int32) As Char

Chars

property Chars[aRange: Range]: String read;

String Chars[Range aRange] { get; }

subscript Chars(_ aRange: Range) -> String { get{} }

String Chars[Range aRange] { __get; }

ReadOnly Property Chars(aRange As Range) As String

Returns true if this string points to a file that exists.

property FileExists: Boolean read;

Boolean FileExists { get; }

var FileExists: Boolean { get{} }

Boolean FileExists { __get; }

ReadOnly Property FileExists() As Boolean

Returns true if this string points to a file or filder that exists.

property FileOrFolderExists: Boolean read;

Boolean FileOrFolderExists { get; }

var FileOrFolderExists: Boolean { get{} }

Boolean FileOrFolderExists { __get; }

ReadOnly Property FileOrFolderExists() As Boolean

FirstLine

Returns this string up to the first line ending, or everything.

property FirstLine: String read;

String FirstLine { get; }

var FirstLine: String { get{} }

String FirstLine { __get; }

ReadOnly Property FirstLine() As String

Returns true if this string points to a folder that exists.

property FolderExists: Boolean read;

Boolean FolderExists { get; }

var FolderExists: Boolean { get{} }

Boolean FolderExists { __get; }

ReadOnly Property FolderExists() As Boolean

IsAbsolutePath

Returns true if this string points to an absolute path.

property IsAbsolutePath: Boolean read;

Boolean IsAbsolutePath { get; }

var IsAbsolutePath: Boolean { get{} }

Boolean IsAbsolutePath { __get; }

ReadOnly Property IsAbsolutePath() As Boolean

IsAbsoluteUnixPath

Returns true if this string points to an absolute unix path.

property IsAbsoluteUnixPath: Boolean read;

Boolean IsAbsoluteUnixPath { get; }

var IsAbsoluteUnixPath: Boolean { get{} }

Boolean IsAbsoluteUnixPath { __get; }

ReadOnly Property IsAbsoluteUnixPath() As Boolean

IsAbsoluteWindowsPath

Returns true if this string points to an absolute windows path.

property IsAbsoluteWindowsPath: Boolean read;

Boolean IsAbsoluteWindowsPath { get; }

var IsAbsoluteWindowsPath: Boolean { get{} }

Boolean IsAbsoluteWindowsPath { __get; }

ReadOnly Property IsAbsoluteWindowsPath() As Boolean

IsWindowsPath

Returns true if this string is a valid windows path.

property IsWindowsPath: Boolean read;

Boolean IsWindowsPath { get; }

var IsWindowsPath: Boolean { get{} }

Boolean IsWindowsPath { __get; }

ReadOnly Property IsWindowsPath() As Boolean

LastPathComponent

Returns the last component of this string, treating it as a path. Splits on the system directory seperator.

property LastPathComponent: String read;

String LastPathComponent { get; }

var LastPathComponent: String { get{} }

String LastPathComponent { __get; }

ReadOnly Property LastPathComponent() As String

LastPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the system directory seperator, ignoring the exception.

property LastPathComponentWithoutExtension: String read;

String LastPathComponentWithoutExtension { get; }

var LastPathComponentWithoutExtension: String { get{} }

String LastPathComponentWithoutExtension { __get; }

ReadOnly Property LastPathComponentWithoutExtension() As String

LastUnixPathComponent

Returns the last component of this string, treating it as a path. Splits on the unix directory seperator.

property LastUnixPathComponent: String read;

String LastUnixPathComponent { get; }

var LastUnixPathComponent: String { get{} }

String LastUnixPathComponent { __get; }

ReadOnly Property LastUnixPathComponent() As String

LastUnixPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the unix directory seperator, ignoring the extension.

property LastUnixPathComponentWithoutExtension: String read;

String LastUnixPathComponentWithoutExtension { get; }

var LastUnixPathComponentWithoutExtension: String { get{} }

String LastUnixPathComponentWithoutExtension { __get; }

ReadOnly Property LastUnixPathComponentWithoutExtension() As String

LastWindowsPathComponent

Returns the last component of this string, treating it as a path. Splits on the windows directory seperator.

property LastWindowsPathComponent: String read;

String LastWindowsPathComponent { get; }

var LastWindowsPathComponent: String { get{} }

String LastWindowsPathComponent { __get; }

ReadOnly Property LastWindowsPathComponent() As String

LastWindowsPathComponentWithoutExtension

Returns the last component of this string, treating it as a path. Splits on the windows directory seperator, ignoring the exxception.

property LastWindowsPathComponentWithoutExtension: String read;

String LastWindowsPathComponentWithoutExtension { get; }

var LastWindowsPathComponentWithoutExtension: String { get{} }

String LastWindowsPathComponentWithoutExtension { __get; }

ReadOnly Property LastWindowsPathComponentWithoutExtension() As String

Length

Returns the length of this string.

property Length: Int32 read;

var Length: Int32 { get{} }

Integer Length { __get; }

ReadOnly Property Length() As Int32

NetworkServerName

Returns the network server name from a path string.

property NetworkServerName: nullable String read;

String? NetworkServerName { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var NetworkServerName: String? { get{} }
// Toffee
var NetworkServerName: String { get{} }

String NetworkServerName { __get; }

ReadOnly Property NetworkServerName() As String?

ParentDirectory

property ParentDirectory: nullable String read;

String? ParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var ParentDirectory: String? { get{} }
// Toffee
var ParentDirectory: String { get{} }

String ParentDirectory { __get; }

ReadOnly Property ParentDirectory() As String?

PathExtension

Returns the extension of this string, treating it as filename.

property PathExtension: String read;

String PathExtension { get; }

var PathExtension: String { get{} }

String PathExtension { __get; }

ReadOnly Property PathExtension() As String

PathWithoutExtension

Returns this string without extension, treating it as filename.

property PathWithoutExtension: String read;

String PathWithoutExtension { get; }

var PathWithoutExtension: String { get{} }

String PathWithoutExtension { __get; }

ReadOnly Property PathWithoutExtension() As String

QuotedIfNeeded

Adds quotes if this string contains whitespace.

property QuotedIfNeeded: String read;

String QuotedIfNeeded { get; }

var QuotedIfNeeded: String { get{} }

String QuotedIfNeeded { __get; }

ReadOnly Property QuotedIfNeeded() As String

ToPathWithLocalFolderPrefixIfRelative

Adds a ./ or .\ if this is a relative path.

property ToPathWithLocalFolderPrefixIfRelative: String read;

String ToPathWithLocalFolderPrefixIfRelative { get; }

var ToPathWithLocalFolderPrefixIfRelative: String { get{} }

String ToPathWithLocalFolderPrefixIfRelative { __get; }

ReadOnly Property ToPathWithLocalFolderPrefixIfRelative() As String

ToPlatformPathFromUnixPath

Converts a unix path to the system path format (does nothing on Unix).

property ToPlatformPathFromUnixPath: String read;

String ToPlatformPathFromUnixPath { get; }

var ToPlatformPathFromUnixPath: String { get{} }

String ToPlatformPathFromUnixPath { __get; }

ReadOnly Property ToPlatformPathFromUnixPath() As String

ToPlatformPathFromWindowsPath

Converts a windows path to the system path format (does nothing on Unix).

property ToPlatformPathFromWindowsPath: String read;

String ToPlatformPathFromWindowsPath { get; }

var ToPlatformPathFromWindowsPath: String { get{} }

String ToPlatformPathFromWindowsPath { __get; }

ReadOnly Property ToPlatformPathFromWindowsPath() As String

ToUnixPath

Convert this to a unix path.

property ToUnixPath: String read;

String ToUnixPath { get; }

var ToUnixPath: String { get{} }

String ToUnixPath { __get; }

ReadOnly Property ToUnixPath() As String

ToUnixPathFromWindowsPath

Convert a Windows path to unix path.

property ToUnixPathFromWindowsPath: String read;

String ToUnixPathFromWindowsPath { get; }

var ToUnixPathFromWindowsPath: String { get{} }

String ToUnixPathFromWindowsPath { __get; }

ReadOnly Property ToUnixPathFromWindowsPath() As String

ToWindowsPath

Convert to a Windows path.

property ToWindowsPath: String read;

String ToWindowsPath { get; }

var ToWindowsPath: String { get{} }

String ToWindowsPath { __get; }

ReadOnly Property ToWindowsPath() As String

ToWindowsPathFromUnixPath

Convert a unix path to a Windows path.

property ToWindowsPathFromUnixPath: String read;

String ToWindowsPathFromUnixPath { get; }

var ToWindowsPathFromUnixPath: String { get{} }

String ToWindowsPathFromUnixPath { __get; }

ReadOnly Property ToWindowsPathFromUnixPath() As String

UnixParentDirectory

property UnixParentDirectory: nullable String read;

String? UnixParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var UnixParentDirectory: String? { get{} }
// Toffee
var UnixParentDirectory: String { get{} }

String UnixParentDirectory { __get; }

ReadOnly Property UnixParentDirectory() As String?

WindowsParentDirectory

property WindowsParentDirectory: nullable String read;

String? WindowsParentDirectory { get; }

// .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
var WindowsParentDirectory: String? { get{} }
// Toffee
var WindowsParentDirectory: String { get{} }

String WindowsParentDirectory { __get; }

ReadOnly Property WindowsParentDirectory() As String?

Empty

Empty string: ''

class property Empty: String read;

class String Empty { get; }

static var Empty: String { get{} }

class String Empty { __get; }

Shared ReadOnly Property Empty() As String

Compare

Compare a string, returns 0 if the same, -1 if less, 1 if greater.

class method Compare(Value1: String; Value2: String): Int32

static Int32 Compare(String Value1, String Value2)

static func Compare(_ Value1: String, _ Value2: String) -> Int32

static Integer Compare(String Value1, String Value2)

Shared Function Compare(Value1 As String, Value2 As String) As Int32

Parameters:

Value1:
Value2:

Returns true if these strings are exactly equivalent.

class method Equals(ValueA: String; ValueB: String): Boolean

static Boolean Equals(String ValueA, String ValueB)

static func Equals(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean Equals(String ValueA, String ValueB)

Shared Function Equals(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

Returns true if these strings are equivalent, ignoring their case.

class method EqualsIgnoringCase(ValueA: String; ValueB: String): Boolean

static Boolean EqualsIgnoringCase(String ValueA, String ValueB)

static func EqualsIgnoringCase(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean EqualsIgnoringCase(String ValueA, String ValueB)

Shared Function EqualsIgnoringCase(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

Returns true if these strings are equivalent, ignoring their case in the invariant culture.

class method EqualsIgnoringCaseInvariant(ValueA: String; ValueB: String): Boolean

static Boolean EqualsIgnoringCaseInvariant(String ValueA, String ValueB)

static func EqualsIgnoringCaseInvariant(_ ValueA: String, _ ValueB: String) -> Boolean

static Boolean EqualsIgnoringCaseInvariant(String ValueA, String ValueB)

Shared Function EqualsIgnoringCaseInvariant(ValueA As String, ValueB As String) As Boolean

Parameters:

ValueA:
ValueB:

Format

Formats the string, uses .NET formatting style for aFormat.

class method Format(aFormat: String; params aParams: array of Object): not nullable String

static String! Format(String aFormat, params Object[] aParams)

static func Format(_ aFormat: String, _ aParams: Object...) -> String

static String Format(String aFormat, Object[]... aParams)

Shared Function Format(aFormat As String, ParamArray aParams As Object()) As String

Parameters:

aFormat:
aParams:

initialize ToffeeV2

IsNullOrEmpty

Returns true if this string is null or empty.

class method IsNullOrEmpty(Value: String): Boolean

static Boolean IsNullOrEmpty(String Value)

static func IsNullOrEmpty(_ Value: String) -> Boolean

static Boolean IsNullOrEmpty(String Value)

Shared Function IsNullOrEmpty(Value As String) As Boolean

Parameters:

Value:

IsNullOrWhiteSpace

Returns true if this string is null, empty or jsut has whitespace.

class method IsNullOrWhiteSpace(Value: String): Boolean

static Boolean IsNullOrWhiteSpace(String Value)

static func IsNullOrWhiteSpace(_ Value: String) -> Boolean

static Boolean IsNullOrWhiteSpace(String Value)

Shared Function IsNullOrWhiteSpace(Value As String) As Boolean

Parameters:

Value:

Join (nullable String, not nullable array of String): not nullable String

Join a string together with aSeparator as separator.

class method Join(aSeparator: nullable String; Values: not nullable array of String): not nullable String

static String! Join(String? aSeparator, String[]! Values)

// Toffee
static func Join(_ aSeparator: String, _ Values: String...) -> String
// ToffeeV2
static func Join(_ aSeparator: String?, _ Values: String...) -> String

static String Join(String aSeparator, String[] Values)

Shared Function Join(aSeparator As String?, Values As String()) As String

Parameters:

aSeparator:
Values:

Join a string together with aSeparator as separator.

class method Join(aSeparator: nullable String; Values: not nullable ImmutableList<String>): not nullable String

static String! Join(String? aSeparator, ImmutableList<String>! Values)

// Toffee
static func Join(_ aSeparator: String, _ Values: ImmutableList<String>) -> String
// ToffeeV2
static func Join(_ aSeparator: String?, _ Values: ImmutableList<String>) -> String

static String Join(String aSeparator, ImmutableList<String> Values)

Shared Function Join(aSeparator As String?, Values As ImmutableList<String>) As String

Parameters:

aSeparator:
Values:

SmartJoin

class method SmartJoin(aStringA: nullable String; aStringB: nullable String) WithSeparator(aSeparator: not nullable String): nullable String

static String? SmartJoin(String? aStringA, String? aStringB) WithSeparator(String! aSeparator)

// Toffee
static func SmartJoin(_ aStringA: String, _ aStringB: String, WithSeparator aSeparator: String) -> String
// ToffeeV2
static func SmartJoin(_ aStringA: String?, _ aStringB: String?, WithSeparator aSeparator: String) -> String?

static String SmartJoin(String aStringA, String aStringB) WithSeparator(String aSeparator)

Shared Function SmartJoin(aStringA As String?, aStringB As String?) WithSeparator(aSeparator As String) As String?

Parameters:

aStringA:
aStringB:
aSeparator:

Creates a string with Value as content, in the encoding given in Encoding.

constructor(aBytes: array of Byte; aEncoding: Encoding := nil)

String(Byte[] aBytes, Encoding aEncoding = null)

init(_ aBytes: Byte..., _ aEncoding: Encoding = nil)

String(Byte[] aBytes, Encoding aEncoding)

Sub New(aBytes As Byte(), aEncoding As Encoding = Null)

Parameters:

aBytes:
aEncoding:

Creates a string with aChar repeated aCount times.

constructor(aChar: Char; aCount: Int32)

String(Char aChar, Int32 aCount)

init(_ aChar: Char, _ aCount: Int32)

String(Char aChar, Integer aCount)

Sub New(aChar As Char, aCount As Int32)

Parameters:

aChar:
aCount:

constructor (array of UnicodeCodePoint)

Creates a string with aCodePoints as content.

constructor(aCodePoints: array of UnicodeCodePoint)

String(UnicodeCodePoint[] aCodePoints)

init(_ aCodePoints: UnicodeCodePoint...)

String(UnicodeCodePoint[] aCodePoints)

Sub New(aCodePoints As UnicodeCodePoint())

Parameters:

aCodePoints:

constructor (List<NSNumber<UnicodeCodePoint>>) ToffeeV2

init(_ aCodePoints: List<NSNumber<UnicodeCodePoint>>)

Parameters:

aCodePoints:

Creates a string with aCodePoints as content.

constructor(aCodePoints: List<UnsignedInteger>)

String(List<UnsignedInteger> aCodePoints)

init(_ aCodePoints: List<UnsignedInteger>)

String(List<UnsignedInteger> aCodePoints)

Sub New(aCodePoints As List<UnsignedInteger>)

Parameters:

aCodePoints:

constructor (List<UnicodeCodePoint>) .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee

Creates a string with aCodePoints as content.

constructor(aCodePoints: List<UnicodeCodePoint>)

String(List<UnicodeCodePoint> aCodePoints)

init(_ aCodePoints: List<nullable UnicodeCodePoint>)

Sub New(aCodePoints As List<UnicodeCodePoint>)

Parameters:

aCodePoints:

constructor (array of Char)

Creates a string with Value as content.

constructor(Value: array of Char)

Parameters:

Value:

Creates a string with Value as content.

constructor(Value: array of Char; Offset: Int32; Count: Int32)

String(Char[] Value, Int32 Offset, Int32 Count)

init(_ Value: Char..., _ Offset: Int32, _ Count: Int32)

String(Char[] Value, Integer Offset, Integer Count)

Sub New(Value As Char(), Offset As Int32, Count As Int32)

Parameters:

Value:
Offset:
Count:

AppendPath

method AppendPath(params aPaths: array of String): nullable String

String? AppendPath(params String[] aPaths)

// Toffee
func AppendPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendPath(_ aPaths: String...) -> String?

String AppendPath(String[]... aPaths)

Function AppendPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

AppendUnixPath

method AppendUnixPath(params aPaths: array of String): nullable String

String? AppendUnixPath(params String[] aPaths)

// Toffee
func AppendUnixPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendUnixPath(_ aPaths: String...) -> String?

String AppendUnixPath(String[]... aPaths)

Function AppendUnixPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

AppendWindowsPath

method AppendWindowsPath(params aPaths: array of String): nullable String

String? AppendWindowsPath(params String[] aPaths)

// Toffee
func AppendWindowsPath(_ aPaths: String...) -> String
// ToffeeV2
func AppendWindowsPath(_ aPaths: String...) -> String?

String AppendWindowsPath(String[]... aPaths)

Function AppendWindowsPath(ParamArray aPaths As String()) As String?

Parameters:

aPaths:

Capitalize

Uppercase this with the default locale.

method Capitalize: not nullable String

func Capitalize() -> String

Function Capitalize() As String

Uppercase this with the given locale.

method Capitalize(aLocale: Locale): not nullable String

String! Capitalize(Locale aLocale)

func Capitalize(_ aLocale: Locale) -> String

String Capitalize(Locale aLocale)

Function Capitalize(aLocale As Locale) As String

Parameters:

aLocale:

CapitalizeInvariant

Uppercase this with the invariant locale.

method CapitalizeInvariant: not nullable String

String! CapitalizeInvariant()

func CapitalizeInvariant() -> String

String CapitalizeInvariant()

Function CapitalizeInvariant() As String

CollapseSpaces

method CollapseSpaces: String

func CollapseSpaces() -> String

Function CollapseSpaces() As String

CompareTo

compare this string to another string.

method CompareTo(Value: String): Int32

Int32 CompareTo(String Value)

func CompareTo(_ Value: String) -> Int32

Integer CompareTo(String Value)

Function CompareTo(Value As String) As Int32

Parameters:

Value:

CompareToIgnoreCase

Compare a string, case insensitive, returns 0 if the same, -1 if less, 1 if greater.

method CompareToIgnoreCase(Value: String): Int32

Int32 CompareToIgnoreCase(String Value)

func CompareToIgnoreCase(_ Value: String) -> Int32

Integer CompareToIgnoreCase(String Value)

Function CompareToIgnoreCase(Value As String) As Int32

Parameters:

Value:

Contains

Returns true if a string contains another string.

method Contains(Value: String): Boolean

Boolean Contains(String Value)

func Contains(_ Value: String) -> Boolean

Boolean Contains(String Value)

Function Contains(Value As String) As Boolean

Parameters:

Value:

Returns true if the string contains anf of the AnyOf characters.

method ContainsAny(AnyOf: array of Char): Boolean

Boolean ContainsAny(Char[] AnyOf)

func ContainsAny(_ AnyOf: Char...) -> Boolean

Boolean ContainsAny(Char[] AnyOf)

Function ContainsAny(AnyOf As Char()) As Boolean

Parameters:

AnyOf:

Returns true if the string contains anf of the AnyOf characters, starts from aStartIndex.

method ContainsAny(AnyOf: array of Char; aStartIndex: Int32): Boolean

Boolean ContainsAny(Char[] AnyOf, Int32 aStartIndex)

func ContainsAny(_ AnyOf: Char..., _ aStartIndex: Int32) -> Boolean

Boolean ContainsAny(Char[] AnyOf, Integer aStartIndex)

Function ContainsAny(AnyOf As Char(), aStartIndex As Int32) As Boolean

Parameters:

AnyOf:
aStartIndex:

ContainsAnyNonASCII

Returns true if the string contains an character > 127.

method ContainsAnyNonASCII: Boolean

Boolean ContainsAnyNonASCII()

func ContainsAnyNonASCII() -> Boolean

Boolean ContainsAnyNonASCII()

Function ContainsAnyNonASCII() As Boolean

Returns true if the string contains an character > 127, starts from aStartIndex.

method ContainsAnyNonASCII(aStartIndex: Int32): Boolean

Boolean ContainsAnyNonASCII(Int32 aStartIndex)

func ContainsAnyNonASCII(_ aStartIndex: Int32) -> Boolean

Boolean ContainsAnyNonASCII(Integer aStartIndex)

Function ContainsAnyNonASCII(aStartIndex As Int32) As Boolean

Parameters:

aStartIndex:

Returns true if the string contains only the AnyOf characters.

method ContainsOnly(AnyOf: array of Char): Boolean

Boolean ContainsOnly(Char[] AnyOf)

func ContainsOnly(_ AnyOf: Char...) -> Boolean

Boolean ContainsOnly(Char[] AnyOf)

Function ContainsOnly(AnyOf As Char()) As Boolean

Parameters:

AnyOf:

Returns true if the string contains only the AnyOf characters, starting at aStartIndex.

method ContainsOnly(AnyOf: array of Char; aStartIndex: Int32): Boolean

Boolean ContainsOnly(Char[] AnyOf, Int32 aStartIndex)

func ContainsOnly(_ AnyOf: Char..., _ aStartIndex: Int32) -> Boolean

Boolean ContainsOnly(Char[] AnyOf, Integer aStartIndex)

Function ContainsOnly(AnyOf As Char(), aStartIndex As Int32) As Boolean

Parameters:

AnyOf:
aStartIndex:

Returns true if a string ends with Value.

method EndsWith(Value: Char): Boolean

Boolean EndsWith(Char Value)

func EndsWith(_ Value: Char) -> Boolean

Boolean EndsWith(Char Value)

Function EndsWith(Value As Char) As Boolean

Parameters:

Value:

Returns true if a string ends with Value.

method EndsWith(Value: String): Boolean

Boolean EndsWith(String Value)

func EndsWith(_ Value: String) -> Boolean

Boolean EndsWith(String Value)

Function EndsWith(Value As String) As Boolean

Parameters:

Value:

Returns true if a string ends with Value.

method EndsWith(Value: String; IgnoreCase: Boolean): Boolean

Boolean EndsWith(String Value, Boolean IgnoreCase)

func EndsWith(_ Value: String, _ IgnoreCase: Boolean) -> Boolean

Boolean EndsWith(String Value, Boolean IgnoreCase)

Function EndsWith(Value As String, IgnoreCase As Boolean) As Boolean

Parameters:

Value:
IgnoreCase:

Returns true if these strings are exactly equivalent.

method Equals(Value: String): Boolean

Boolean Equals(String Value)

func Equals(_ Value: String) -> Boolean

Boolean Equals(String Value)

Function Equals(Value As String) As Boolean

Parameters:

Value:

Returns true if these strings are equivalent, ignoring their case.

method EqualsIgnoringCase(Value: String): Boolean

Boolean EqualsIgnoringCase(String Value)

func EqualsIgnoringCase(_ Value: String) -> Boolean

Boolean EqualsIgnoringCase(String Value)

Function EqualsIgnoringCase(Value As String) As Boolean

Parameters:

Value:

Returns true if these strings are equivalent, ignoring their case in the invariant culture.

method EqualsIgnoringCaseInvariant(Value: String): Boolean

Boolean EqualsIgnoringCaseInvariant(String Value)

func EqualsIgnoringCaseInvariant(_ Value: String) -> Boolean

Boolean EqualsIgnoringCaseInvariant(String Value)

Function EqualsIgnoringCaseInvariant(Value As String) As Boolean

Parameters:

Value:

FuzzyMatches

Does a "fuzzy" match. Given the current string, ensures each character is in aHaystack in sequential order.

method FuzzyMatches(aHaystack: not nullable String): Boolean

Boolean FuzzyMatches(String! aHaystack)

func FuzzyMatches(_ aHaystack: String) -> Boolean

Boolean FuzzyMatches(String aHaystack)

Function FuzzyMatches(aHaystack As String) As Boolean

Parameters:

aHaystack:

GetSequence

Returns an iterator that yields each character in this string in order.

method GetSequence: IEnumerable<Char>

IEnumerable<Char> GetSequence()

// Toffee
func GetSequence() -> INSFastEnumeration<__ElementsBoxedChar>
// ToffeeV2
func GetSequence() -> IEnumerable<Char>

Iterable<Character> GetSequence()

Function GetSequence() As IEnumerable<Char>

IndexAfterJoinedUnicodeCharacterCoveringIndex

method IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex: Int32): Int32

Int32 IndexAfterJoinedUnicodeCharacterCoveringIndex(Int32 aIndex)

func IndexAfterJoinedUnicodeCharacterCoveringIndex(_ aIndex: Int32) -> Int32

Integer IndexAfterJoinedUnicodeCharacterCoveringIndex(Integer aIndex)

Function IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex As Int32) As Int32

Parameters:

aIndex:

Returns the index of Value in this string, returning -1 if it's not there.

method IndexOf(Value: Char): Int32

Int32 IndexOf(Char Value)

func IndexOf(_ Value: Char) -> Int32

Integer IndexOf(Char Value)

Function IndexOf(Value As Char) As Int32

Parameters:

Value:

Returns the index of Value in this string, start at StartIndex, returning -1 if it's not there.

method IndexOf(Value: Char; StartIndex: Int32): Int32

Int32 IndexOf(Char Value, Int32 StartIndex)

func IndexOf(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer IndexOf(Char Value, Integer StartIndex)

Function IndexOf(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of Value in this string, returning -1 if it's not there.

method IndexOf(Value: String): Int32

Int32 IndexOf(String Value)

func IndexOf(_ Value: String) -> Int32

Integer IndexOf(String Value)

Function IndexOf(Value As String) As Int32

Parameters:

Value:

Returns the index of Value in this string, start at StartIndex, returning -1 if it's not there.

method IndexOf(Value: String; StartIndex: Int32): Int32

Int32 IndexOf(String Value, Int32 StartIndex)

func IndexOf(_ Value: String, _ StartIndex: Int32) -> Int32

Integer IndexOf(String Value, Integer StartIndex)

Function IndexOf(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of any of these characters, or -1 if none can be found.

method IndexOfAny(AnyOf: array of Char): Int32

Int32 IndexOfAny(Char[] AnyOf)

func IndexOfAny(_ AnyOf: Char...) -> Int32

Integer IndexOfAny(Char[] AnyOf)

Function IndexOfAny(AnyOf As Char()) As Int32

Parameters:

AnyOf:

Returns the index of any of these characters, starting at StartIndex, or -1 if none can be found.

method IndexOfAny(AnyOf: array of Char; StartIndex: Int32): Int32

Int32 IndexOfAny(Char[] AnyOf, Int32 StartIndex)

func IndexOfAny(_ AnyOf: Char..., _ StartIndex: Int32) -> Int32

Integer IndexOfAny(Char[] AnyOf, Integer StartIndex)

Function IndexOfAny(AnyOf As Char(), StartIndex As Int32) As Int32

Parameters:

AnyOf:
StartIndex:

Returns the index of Value in this string, case insensitive, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: Char): Int32

Int32 IndexOfIgnoringCase(Char Value)

func IndexOfIgnoringCase(_ Value: Char) -> Int32

Integer IndexOfIgnoringCase(Char Value)

Function IndexOfIgnoringCase(Value As Char) As Int32

Parameters:

Value:

Returns the index of Value in this string, case insensitive, starting at StartIndex, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: Char; StartIndex: Int32): Int32

Int32 IndexOfIgnoringCase(Char Value, Int32 StartIndex)

func IndexOfIgnoringCase(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer IndexOfIgnoringCase(Char Value, Integer StartIndex)

Function IndexOfIgnoringCase(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the index of Value in this string, case insensitive, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: String): Int32

Int32 IndexOfIgnoringCase(String Value)

func IndexOfIgnoringCase(_ Value: String) -> Int32

Integer IndexOfIgnoringCase(String Value)

Function IndexOfIgnoringCase(Value As String) As Int32

Parameters:

Value:

Returns the index of Value in this string, case insensitive, starting at StartIndex, returning -1 if it's not there.

method IndexOfIgnoringCase(Value: String; StartIndex: Int32): Int32

Int32 IndexOfIgnoringCase(String Value, Int32 StartIndex)

func IndexOfIgnoringCase(_ Value: String, _ StartIndex: Int32) -> Int32

Integer IndexOfIgnoringCase(String Value, Integer StartIndex)

Function IndexOfIgnoringCase(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Insert

Insert a string into this string, returning the new string.

method Insert(aIndex: Int32; aNewValue: String): not nullable String

String! Insert(Int32 aIndex, String aNewValue)

func Insert(_ aIndex: Int32, _ aNewValue: String) -> String

String Insert(Integer aIndex, String aNewValue)

Function Insert(aIndex As Int32, aNewValue As String) As String

Parameters:

aIndex:
aNewValue:

IsIndexInsideOfAJoinedUnicodeCharacter

method IsIndexInsideOfAJoinedUnicodeCharacter(aIndex: Int32): Boolean

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Int32 aIndex)

func IsIndexInsideOfAJoinedUnicodeCharacter(_ aIndex: Int32) -> Boolean

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Integer aIndex)

Function IsIndexInsideOfAJoinedUnicodeCharacter(aIndex As Int32) As Boolean

Parameters:

aIndex:

IsIndexInsideOfASurrogatePair

method IsIndexInsideOfASurrogatePair(aIndex: Int32): Boolean

Boolean IsIndexInsideOfASurrogatePair(Int32 aIndex)

func IsIndexInsideOfASurrogatePair(_ aIndex: Int32) -> Boolean

Boolean IsIndexInsideOfASurrogatePair(Integer aIndex)

Function IsIndexInsideOfASurrogatePair(aIndex As Int32) As Boolean

Parameters:

aIndex:

Returns the last index of Value in this string, returning -1 if it's not there.

method LastIndexOf(Value: Char): Int32

Int32 LastIndexOf(Char Value)

func LastIndexOf(_ Value: Char) -> Int32

Integer LastIndexOf(Char Value)

Function LastIndexOf(Value As Char) As Int32

Parameters:

Value:

Returns the last index of Value in this string, starting at StartIndex, returning -1 if it's not there.

method LastIndexOf(Value: Char; StartIndex: Int32): Int32

Int32 LastIndexOf(Char Value, Int32 StartIndex)

func LastIndexOf(_ Value: Char, _ StartIndex: Int32) -> Int32

Integer LastIndexOf(Char Value, Integer StartIndex)

Function LastIndexOf(Value As Char, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

Returns the last index of Value in this string, returning -1 if it's not there.

method LastIndexOf(Value: String): Int32

Int32 LastIndexOf(String Value)

func LastIndexOf(_ Value: String) -> Int32

Integer LastIndexOf(String Value)

Function LastIndexOf(Value As String) As Int32

Parameters:

Value:

Returns the last index of Value in this string, starting at StartIndex, returning -1 if it's not there.

method LastIndexOf(Value: String; StartIndex: Int32): Int32

Int32 LastIndexOf(String Value, Int32 StartIndex)

func LastIndexOf(_ Value: String, _ StartIndex: Int32) -> Int32

Integer LastIndexOf(String Value, Integer StartIndex)

Function LastIndexOf(Value As String, StartIndex As Int32) As Int32

Parameters:

Value:
StartIndex:

LastIndexOfAny (array of Char): Int32

Returns the last index of any of these characters, or -1 if none can be found.

method LastIndexOfAny(AnyOf: array of Char): Int32

Int32 LastIndexOfAny(Char[] AnyOf)

func LastIndexOfAny(_ AnyOf: Char...) -> Int32

Integer LastIndexOfAny(Char[] AnyOf)

Function LastIndexOfAny(AnyOf As Char()) As Int32

Parameters:

AnyOf:

Returns the last index of any of these characters, starting at StartIndex, or -1 if none can be found.

method LastIndexOfAny(AnyOf: array of Char; StartIndex: Int32): Int32

Int32 LastIndexOfAny(Char[] AnyOf, Int32 StartIndex)

func LastIndexOfAny(_ AnyOf: Char..., _ StartIndex: Int32) -> Int32

Integer LastIndexOfAny(Char[] AnyOf, Integer StartIndex)

Function LastIndexOfAny(AnyOf As Char(), StartIndex As Int32) As Int32

Parameters:

AnyOf:
StartIndex:

LevenshteinDistanceTo

Returns the levenshtein distance to another string, essentially returns the number of differences between these strings, returning the nr of inserts, deletions and replacements.

method LevenshteinDistanceTo(aOther: not nullable String): Int32

Int32 LevenshteinDistanceTo(String! aOther)

func LevenshteinDistanceTo(_ aOther: String) -> Int32

Integer LevenshteinDistanceTo(String aOther)

Function LevenshteinDistanceTo(aOther As String) As Int32

Parameters:

aOther:

Pads the string so it's at least total width, with whitespaces.

method PadEnd(TotalWidth: Int32): not nullable String

String! PadEnd(Int32 TotalWidth)

func PadEnd(_ TotalWidth: Int32) -> String

String PadEnd(Integer TotalWidth)

Function PadEnd(TotalWidth As Int32) As String

Parameters:

TotalWidth:

Pads the string so it's at least total width, with padding characters.

method PadEnd(TotalWidth: Int32; PaddingChar: Char): not nullable String

String! PadEnd(Int32 TotalWidth, Char PaddingChar)

func PadEnd(_ TotalWidth: Int32, _ PaddingChar: Char) -> String

String PadEnd(Integer TotalWidth, Char PaddingChar)

Function PadEnd(TotalWidth As Int32, PaddingChar As Char) As String

Parameters:

TotalWidth:
PaddingChar:

Pads the string so it's at least total width, with whitespaces.

method PadStart(TotalWidth: Int32): not nullable String

String! PadStart(Int32 TotalWidth)

func PadStart(_ TotalWidth: Int32) -> String

String PadStart(Integer TotalWidth)

Function PadStart(TotalWidth As Int32) As String

Parameters:

TotalWidth:

Pads the string so it's at least total width, with padding characters.

method PadStart(TotalWidth: Int32; PaddingChar: Char): not nullable String

String! PadStart(Int32 TotalWidth, Char PaddingChar)

func PadStart(_ TotalWidth: Int32, _ PaddingChar: Char) -> String

String PadStart(Integer TotalWidth, Char PaddingChar)

Function PadStart(TotalWidth As Int32, PaddingChar As Char) As String

Parameters:

TotalWidth:
PaddingChar:

Plural

method Plural(aCount: Int32; aPluralVersion: not nullable String): not nullable String

String! Plural(Int32 aCount, String! aPluralVersion)

func Plural(_ aCount: Int32, _ aPluralVersion: String) -> String

String Plural(Integer aCount, String aPluralVersion)

Function Plural(aCount As Int32, aPluralVersion As String) As String

Parameters:

aCount:
aPluralVersion:

PluralInvariant

method PluralInvariant(aCount: Int32; aPluralVersion: nullable String := nil): not nullable String

String! PluralInvariant(Int32 aCount, String? aPluralVersion = null)

// Toffee
func PluralInvariant(_ aCount: Int32, _ aPluralVersion: String = nil) -> String
// ToffeeV2
func PluralInvariant(_ aCount: Int32, _ aPluralVersion: String? = nil) -> String

String PluralInvariant(Integer aCount, String aPluralVersion)

Function PluralInvariant(aCount As Int32, aPluralVersion As String? = Null) As String

Parameters:

aCount:
aPluralVersion:

method ProcessVariables(aStyle: VariableStyle; aCallback: Func<not nullable String, wrapped nullable String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Func<not nullable String, wrapped nullable String> aCallback)

// Toffee
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String) -> String) -> String
// ToffeeV2
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String) -> String?) -> String

String ProcessVariables(VariableStyle aStyle, Func2<String, String> aCallback)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func (Of String, String?)) As String
// Island
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func<not nullable String, wrapped nullable String>) As String

Parameters:

aStyle:
aCallback:

method ProcessVariables(aStyle: VariableStyle; aCallback: Func<not nullable String, VariableStatus, wrapped nullable String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Func<not nullable String, VariableStatus, wrapped nullable String> aCallback)

// Toffee
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String, VariableStatus) -> String) -> String
// ToffeeV2
func ProcessVariables(_ aStyle: VariableStyle, _ aCallback: (String, VariableStatus) -> String?) -> String

String ProcessVariables(VariableStyle aStyle, Func3<String, VariableStatus, String> aCallback)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func (Of String, VariableStatus, String?)) As String
// Island
Function ProcessVariables(aStyle As VariableStyle, aCallback As Func<not nullable String, VariableStatus, wrapped nullable String>) As String

Parameters:

aStyle:
aCallback:

method ProcessVariables(aStyle: VariableStyle; aValues: Dictionary<String, String>): not nullable String

String! ProcessVariables(VariableStyle aStyle, Dictionary<String, String> aValues)

func ProcessVariables(_ aStyle: VariableStyle, _ aValues: Dictionary<String, String>) -> String

String ProcessVariables(VariableStyle aStyle, Dictionary<String, String> aValues)

Function ProcessVariables(aStyle As VariableStyle, aValues As Dictionary<String, String>) As String

Parameters:

aStyle:
aValues:

Removes a range from this string, returning the new stirng.

method Remove(aStartIndex: Int32; aLength: Int32): not nullable String

String! Remove(Int32 aStartIndex, Int32 aLength)

func Remove(_ aStartIndex: Int32, _ aLength: Int32) -> String

String Remove(Integer aStartIndex, Integer aLength)

Function Remove(aStartIndex As Int32, aLength As Int32) As String

Parameters:

aStartIndex:
aLength:

Removes a range from this string, returning the new stirng.

method Remove(OldValue: String): not nullable String

String! Remove(String OldValue)

func Remove(_ OldValue: String) -> String

String Remove(String OldValue)

Function Remove(OldValue As String) As String

Parameters:

OldValue:

Replace a range in this string with new substring.

method Replace(aStartIndex: Int32; aLength: Int32; aNewValue: String): not nullable String

String! Replace(Int32 aStartIndex, Int32 aLength, String aNewValue)

func Replace(_ aStartIndex: Int32, _ aLength: Int32, _ aNewValue: String) -> String

String Replace(Integer aStartIndex, Integer aLength, String aNewValue)

Function Replace(aStartIndex As Int32, aLength As Int32, aNewValue As String) As String

Parameters:

aStartIndex:
aLength:
aNewValue:

Replace all occurances of a string with another value.

method Replace(OldValue: String; NewValue: String): not nullable String

String! Replace(String OldValue, String NewValue)

func Replace(_ OldValue: String, _ NewValue: String) -> String

String Replace(String OldValue, String NewValue)

Function Replace(OldValue As String, NewValue As String) As String

Parameters:

OldValue:
NewValue:

Split

Split this string on aSeparator.

method Split(aSeparator: not nullable String; aRemoveEmptyEntries: Boolean := false): not nullable ImmutableList<String>

ImmutableList<String>! Split(String! aSeparator, Boolean aRemoveEmptyEntries = false)

func Split(_ aSeparator: String, _ aRemoveEmptyEntries: Boolean = false) -> ImmutableList<String>

ImmutableList<String> Split(String aSeparator, Boolean aRemoveEmptyEntries)

Function Split(aSeparator As String, aRemoveEmptyEntries As Boolean = false) As ImmutableList<String>

Parameters:

aSeparator:
aRemoveEmptyEntries:

SplitAtFirstOccurrenceOf

Split this string but at most once at the first occurance of aSeperator.

method SplitAtFirstOccurrenceOf(aSeparator: not nullable String): not nullable ImmutableList<String>

ImmutableList<String>! SplitAtFirstOccurrenceOf(String! aSeparator)

func SplitAtFirstOccurrenceOf(_ aSeparator: String) -> ImmutableList<String>

ImmutableList<String> SplitAtFirstOccurrenceOf(String aSeparator)

Function SplitAtFirstOccurrenceOf(aSeparator As String) As ImmutableList<String>

Parameters:

aSeparator:

SplitAtLastOccurrenceOf

Split this string but at most once at the last occurance of aSeperator.

method SplitAtLastOccurrenceOf(aSeparator: not nullable String): not nullable ImmutableList<String>

ImmutableList<String>! SplitAtLastOccurrenceOf(String! aSeparator)

func SplitAtLastOccurrenceOf(_ aSeparator: String) -> ImmutableList<String>

ImmutableList<String> SplitAtLastOccurrenceOf(String aSeparator)

Function SplitAtLastOccurrenceOf(aSeparator As String) As ImmutableList<String>

Parameters:

aSeparator:

StartIndexOfJoinedUnicodeCharacterAtIndex

method StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex: Int32): Int32

Int32 StartIndexOfJoinedUnicodeCharacterAtIndex(Int32 aIndex)

func StartIndexOfJoinedUnicodeCharacterAtIndex(_ aIndex: Int32) -> Int32

Integer StartIndexOfJoinedUnicodeCharacterAtIndex(Integer aIndex)

Function StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex As Int32) As Int32

Parameters:

aIndex:

True if this string starts with Value

method StartsWith(Value: Char): Boolean

Boolean StartsWith(Char Value)

func StartsWith(_ Value: Char) -> Boolean

Boolean StartsWith(Char Value)

Function StartsWith(Value As Char) As Boolean

Parameters:

Value:

True if this string starts with Value

method StartsWith(Value: String): Boolean

Boolean StartsWith(String Value)

func StartsWith(_ Value: String) -> Boolean

Boolean StartsWith(String Value)

Function StartsWith(Value As String) As Boolean

Parameters:

Value:

True if this string starts with Value

method StartsWith(Value: String; IgnoreCase: Boolean): Boolean

Boolean StartsWith(String Value, Boolean IgnoreCase)

func StartsWith(_ Value: String, _ IgnoreCase: Boolean) -> Boolean

Boolean StartsWith(String Value, Boolean IgnoreCase)

Function StartsWith(Value As String, IgnoreCase As Boolean) As Boolean

Parameters:

Value:
IgnoreCase:

method Substring(aRange: Range): not nullable String

String! Substring(Range aRange)

func Substring(_ aRange: Range) -> String

String Substring(Range aRange)

Function Substring(aRange As Range) As String

Parameters:

aRange:

Returns a substring of this string, starting at StartIndex.

method Substring(StartIndex: Int32): not nullable String

String! Substring(Int32 StartIndex)

func Substring(_ StartIndex: Int32) -> String

String Substring(Integer StartIndex)

Function Substring(StartIndex As Int32) As String

Parameters:

StartIndex:

Returns a substring from StartIndex for aLength of this string.

method Substring(StartIndex: Int32; aLength: Int32): not nullable String

String! Substring(Int32 StartIndex, Int32 aLength)

func Substring(_ StartIndex: Int32, _ aLength: Int32) -> String

String Substring(Integer StartIndex, Integer aLength)

Function Substring(StartIndex As Int32, aLength As Int32) As String

Parameters:

StartIndex:
aLength:

SubstringFromFirstOccurrenceOf

Returns a substring of this string, starting at the first occurance of aSeperator.

method SubstringFromFirstOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringFromFirstOccurrenceOf(String! aSeparator)

func SubstringFromFirstOccurrenceOf(_ aSeparator: String) -> String

String SubstringFromFirstOccurrenceOf(String aSeparator)

Function SubstringFromFirstOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringFromLastOccurrenceOf

Returns a substring of this string, starting at the last occurance of aSeperator.

method SubstringFromLastOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringFromLastOccurrenceOf(String! aSeparator)

func SubstringFromLastOccurrenceOf(_ aSeparator: String) -> String

String SubstringFromLastOccurrenceOf(String aSeparator)

Function SubstringFromLastOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringToFirstOccurrenceOf

Returns a substring of this string, stopping at the first occurance of aSeperator.

method SubstringToFirstOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringToFirstOccurrenceOf(String! aSeparator)

func SubstringToFirstOccurrenceOf(_ aSeparator: String) -> String

String SubstringToFirstOccurrenceOf(String aSeparator)

Function SubstringToFirstOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

SubstringToLastOccurrenceOf

Returns a substring of this string, stopping at the last occurance of aSeperator.

method SubstringToLastOccurrenceOf(aSeparator: not nullable String): not nullable String

String! SubstringToLastOccurrenceOf(String! aSeparator)

func SubstringToLastOccurrenceOf(_ aSeparator: String) -> String

String SubstringToLastOccurrenceOf(String aSeparator)

Function SubstringToLastOccurrenceOf(aSeparator As String) As String

Parameters:

aSeparator:

ToByteArray

Converts this string to utf8.

method ToByteArray: not nullable array of Byte

func ToByteArray() -> Byte...

Function ToByteArray() As Byte()

ToByteArray (not nullable Encoding): not nullable array of Byte

Convert this string to the given encoding.

method ToByteArray(aEncoding: not nullable Encoding): not nullable array of Byte

Byte[]! ToByteArray(Encoding! aEncoding)

func ToByteArray(_ aEncoding: Encoding) -> Byte...

Byte[] ToByteArray(Encoding aEncoding)

Function ToByteArray(aEncoding As Encoding) As Byte()

Parameters:

aEncoding:

ToCharArray

Convert this string to an array.

method ToCharArray: not nullable array of Char

func ToCharArray() -> Char...

Function ToCharArray() As Char()

ToHexString

Convert this string to he.x

method ToHexString: String

func ToHexString() -> String

Function ToHexString() As String

ToLower

Lowrcase this string in the default locale.

method ToLower: not nullable String

Function ToLower() As String

Lowrcase this string in the given locale.

method ToLower(aLocale: Locale): not nullable String

String! ToLower(Locale aLocale)

func ToLower(_ aLocale: Locale) -> String

String ToLower(Locale aLocale)

Function ToLower(aLocale As Locale) As String

Parameters:

aLocale:

ToLowerInvariant

Lowrcase this string in the invariant locale.

method ToLowerInvariant: not nullable String

String! ToLowerInvariant()

func ToLowerInvariant() -> String

String ToLowerInvariant()

Function ToLowerInvariant() As String

ToPathRelativeToFolder (not nullable String) Always(Boolean): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String) Always(aAlways: Boolean): nullable String

String? ToPathRelativeToFolder(String! aBasePath) Always(Boolean aAlways)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String, Always aAlways: Boolean) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String, Always aAlways: Boolean) -> String?

String ToPathRelativeToFolder(String aBasePath) Always(Boolean aAlways)

Function ToPathRelativeToFolder(aBasePath As String) Always(aAlways As Boolean) As String?

Parameters:

aBasePath:
aAlways:

ToPathRelativeToFolder (not nullable String) Threshold(Int32): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String) Threshold(aThreshold: Int32): nullable String

String? ToPathRelativeToFolder(String! aBasePath) Threshold(Int32 aThreshold)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String, Threshold aThreshold: Int32) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String, Threshold aThreshold: Int32) -> String?

String ToPathRelativeToFolder(String aBasePath) Threshold(Integer aThreshold)

Function ToPathRelativeToFolder(aBasePath As String) Threshold(aThreshold As Int32) As String?

Parameters:

aBasePath:
aThreshold:

ToPathRelativeToFolder (not nullable String): nullable String

method ToPathRelativeToFolder(aBasePath: not nullable String): nullable String

String? ToPathRelativeToFolder(String! aBasePath)

// Toffee
func ToPathRelativeToFolder(_ aBasePath: String) -> String
// ToffeeV2
func ToPathRelativeToFolder(_ aBasePath: String) -> String?

String ToPathRelativeToFolder(String aBasePath)

Function ToPathRelativeToFolder(aBasePath As String) As String?

Parameters:

aBasePath:

ToUnicodeCharacters

Convert this string to utf32 unicode characters.

method ToUnicodeCharacters: ImmutableList<UnicodeCharacter>

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

func ToUnicodeCharacters() -> ImmutableList<UnicodeCharacter>

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

Function ToUnicodeCharacters() As ImmutableList<UnicodeCharacter>

ToUnicodeCodePointIndices

Convert this string to utf32 unicode characters.

method ToUnicodeCodePointIndices: ImmutableList<Int32>

ImmutableList<Int32> ToUnicodeCodePointIndices()

// Toffee
func ToUnicodeCodePointIndices() -> ImmutableList<nullable Int32>
// ToffeeV2
func ToUnicodeCodePointIndices() -> ImmutableList<NSNumber<Int32>>

ImmutableList<Integer> ToUnicodeCodePointIndices()

Function ToUnicodeCodePointIndices() As ImmutableList<Int32>

ToUnicodeCodePoints

Convert this string to utf32 unicode characters.

method ToUnicodeCodePoints: ImmutableList<UnicodeCodePoint>

ImmutableList<UnicodeCodePoint> ToUnicodeCodePoints()

// Toffee
func ToUnicodeCodePoints() -> ImmutableList<nullable UnicodeCodePoint>
// ToffeeV2
func ToUnicodeCodePoints() -> ImmutableList<NSNumber<UnicodeCodePoint>>

ImmutableList<UnsignedInteger> ToUnicodeCodePoints()

Function ToUnicodeCodePoints() As ImmutableList<UnicodeCodePoint>

ToUpper

Uppercase this string in the default locale.

method ToUpper: not nullable String

Function ToUpper() As String

Uppercase this string in the given locale.

method ToUpper(aLocale: Locale): not nullable String

String! ToUpper(Locale aLocale)

func ToUpper(_ aLocale: Locale) -> String

String ToUpper(Locale aLocale)

Function ToUpper(aLocale As Locale) As String

Parameters:

aLocale:

ToUpperInvariant

Uppercase this string in the invariant locale.

method ToUpperInvariant: not nullable String

String! ToUpperInvariant()

func ToUpperInvariant() -> String

String ToUpperInvariant()

Function ToUpperInvariant() As String

Trim

Trim this string, on both ends with all unicode whitespace characters.

method Trim: not nullable String

Function Trim() As String

Trim (array of Char): not nullable String

Trim this string, on both ends with the given characters.

method Trim(params TrimChars: array of Char): not nullable String

String! Trim(params Char[] TrimChars)

func Trim(_ TrimChars: Char...) -> String

String Trim(Char[]... TrimChars)

Function Trim(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

TrimEnd

Trim this string, at the end with all unicode whitespace characters.

method TrimEnd: not nullable String

Function TrimEnd() As String

TrimEnd (array of Char): not nullable String

Trim this string, at the end with the given characters.

method TrimEnd(params TrimChars: array of Char): not nullable String

String! TrimEnd(params Char[] TrimChars)

func TrimEnd(_ TrimChars: Char...) -> String

String TrimEnd(Char[]... TrimChars)

Function TrimEnd(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

TrimNewLineCharacters

Removes newline characters at the end/start of the string.

method TrimNewLineCharacters: not nullable String

String! TrimNewLineCharacters()

func TrimNewLineCharacters() -> String

String TrimNewLineCharacters()

Function TrimNewLineCharacters() As String

TrimStart

Trim this string, at the start with all unicode whitespace characters.

method TrimStart: not nullable String

func TrimStart() -> String

Function TrimStart() As String

TrimStart (array of Char): not nullable String

Trim this string, at the start with the given characters.

method TrimStart(params TrimChars: array of Char): not nullable String

String! TrimStart(params Char[] TrimChars)

func TrimStart(_ TrimChars: Char...) -> String

String TrimStart(Char[]... TrimChars)

Function TrimStart(ParamArray TrimChars As Char()) As String

Parameters:

TrimChars:

Truncate

method Truncate(aLength: Int32; aEllipsis: String := '…'; aStyle: StringTruncationStyle := StringTruncationStyle.End): String

String Truncate(Int32 aLength, String aEllipsis = \"…\", StringTruncationStyle aStyle = StringTruncationStyle.End)

func Truncate(_ aLength: Int32, _ aEllipsis: String = \"…\", _ aStyle: StringTruncationStyle = StringTruncationStyle.End) -> String

String Truncate(Integer aLength, String aEllipsis, StringTruncationStyle aStyle)

Function Truncate(aLength As Int32, aEllipsis As String = \"…\", aStyle As StringTruncationStyle = StringTruncationStyle.End) As String

Parameters:

aLength:
aEllipsis:
aStyle:

UnicodeCodePointAtIndex

Returns the unicode code point at a given index.

method UnicodeCodePointAtIndex(aIndex: Int32): UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointAtIndex(Int32 aIndex)

func UnicodeCodePointAtIndex(_ aIndex: Int32) -> UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointAtIndex(Integer aIndex)

Function UnicodeCodePointAtIndex(aIndex As Int32) As UnicodeCodePoint

Parameters:

aIndex:

UnicodeCodePointBeforeIndex

Returns the unicode code point before a given index.

method UnicodeCodePointBeforeIndex(aIndex: Int32): UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointBeforeIndex(Int32 aIndex)

func UnicodeCodePointBeforeIndex(_ aIndex: Int32) -> UnicodeCodePoint

UnicodeCodePoint UnicodeCodePointBeforeIndex(Integer aIndex)

Function UnicodeCodePointBeforeIndex(aIndex As Int32) As UnicodeCodePoint

Parameters:

aIndex:

method Unique(aValidator: not nullable Func<String, Boolean>; aStartIndex: Int32 := 2; aApplyPattern: Func<Int32, String>): String

String Unique(Func<String, Boolean>! aValidator, Int32 aStartIndex = 2, Func<Int32, String> aApplyPattern)

func Unique(_ aValidator: (String) -> Boolean, _ aStartIndex: Int32 = 2, _ aApplyPattern: (Int32) -> String) -> String

String Unique(Func2<String, Boolean> aValidator, Integer aStartIndex, Func2<Integer, String> aApplyPattern)

// .NET, .NET Core 6.0, .NET Standard 2.0
Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aApplyPattern As Func (Of Int32, String)) As String
// Island
Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aApplyPattern As Func<Int32, String>) As String

Parameters:

aValidator:
aStartIndex:
aApplyPattern:

method Unique(aValidator: not nullable Func<String, Boolean>; aStartIndex: Int32 := 2; aPattern: not nullable String := ' {0}'): String

String Unique(Func<String, Boolean>! aValidator, Int32 aStartIndex = 2, String! aPattern = \" {0}\")

func Unique(_ aValidator: (String) -> Boolean, _ aStartIndex: Int32 = 2, _ aPattern: String = \" {0}\") -> String

String Unique(Func2<String, Boolean> aValidator, Integer aStartIndex, String aPattern)

Function Unique(aValidator As Func (Of String, Boolean), aStartIndex As Int32 = 2, aPattern As String = \" {0}\") As String

Parameters:

aValidator:
aStartIndex:
aPattern:

method UniqueFilePath(aStartIndex: Int32 := 2; aPattern: String := ' {0}'): String

String UniqueFilePath(Int32 aStartIndex = 2, String aPattern = \" {0}\")

func UniqueFilePath(_ aStartIndex: Int32 = 2, _ aPattern: String = \" {0}\") -> String

String UniqueFilePath(Integer aStartIndex, String aPattern)

Function UniqueFilePath(aStartIndex As Int32 = 2, aPattern As String = \" {0}\") As String

Parameters:

aStartIndex:
aPattern: