String

Overview

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

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Mapped to: PlatformString

 

constructor (array of Byte, Encoding)

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

 

constructor(Value: array of Byte; Encoding: Encoding)

 

String(Byte[] Value, Encoding Encoding)

 

init(_ Value: Byte..., _ Encoding: Encoding)

 

String(Byte[] Value, Encoding Encoding)

Parameters:

  • Value:
  • Encoding:

constructor (array of Char)

Creates a string with Value as content.

 

constructor(Value: array of Char)

 

String(Char[] Value)

 

init(_ Value: Char...)

 

String(Char[] Value)

Parameters:

  • Value:

constructor (array of Char, Int32, Int32)

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)

Parameters:

  • Value:
  • Offset:
  • Count:

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)

Parameters:

  • aCodePoints:

constructor (Char, Int32)

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)

Parameters:

  • aChar:
  • aCount:

constructor (List<nullable UnicodeCodePoint>) Toffee

Creates a string with aCodePoints as content.

 

init(_ aCodePoints: List<nullable UnicodeCodePoint>)

Parameters:

  • aCodePoints:

constructor (List<UnicodeCodePoint>) .NET, .NET Standard 2.0, Island, ToffeeV2

Creates a string with aCodePoints as content.

 

constructor(aCodePoints: List<UnicodeCodePoint>)

 

String(List<UnicodeCodePoint> aCodePoints)

 

init(_ aCodePoints: List<UnicodeCodePoint>)

Parameters:

  • aCodePoints:

constructor (List<UnsignedInteger>) Cooper

Creates a string with aCodePoints as content.

 

constructor(aCodePoints: List<UnsignedInteger>)

 

String(List<UnsignedInteger> aCodePoints)

 

init(_ aCodePoints: List<UnsignedInteger>)

 

String(List<UnsignedInteger> aCodePoints)

Parameters:

  • aCodePoints:

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)

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)

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)

Parameters:

  • aPaths:

Capitalize

Uppercase this with the default locale.

 

method Capitalize: not nullable String

 

String! Capitalize()

 

func Capitalize() -> String

 

String! Capitalize()

Capitalize (Locale): not nullable 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)

Parameters:

  • aLocale:

CapitalizeInvariant

Uppercase this with the invariant locale.

 

method CapitalizeInvariant: not nullable String

 

String! CapitalizeInvariant()

 

func CapitalizeInvariant() -> String

 

String! CapitalizeInvariant()

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; }

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)

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)

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)

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)

Parameters:

  • Value:

ContainsAny (array of Char): Boolean

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)

Parameters:

  • AnyOf:

ContainsAny (array of Char, Int32): Boolean

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)

Parameters:

  • AnyOf:
  • aStartIndex:

ContainsAnyNonASCII

Returns true if the string contains an character > 127.

 

method ContainsAnyNonASCII: Boolean

 

Boolean ContainsAnyNonASCII()

 

func ContainsAnyNonASCII() -> Boolean

 

Boolean ContainsAnyNonASCII()

ContainsAnyNonASCII (Int32): 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)

Parameters:

  • aStartIndex:

ContainsOnly (array of Char): Boolean

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)

Parameters:

  • AnyOf:

ContainsOnly (array of Char, Int32): Boolean

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)

Parameters:

  • AnyOf:
  • aStartIndex:

Empty

Empty string: ''

 

class property Empty: String read;

 

class String Empty { get; }

 

static var Empty: String { get{} }

 

class String Empty { __get; }

EndsWith (Char): Boolean

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)

Parameters:

  • Value:

EndsWith (String): Boolean

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)

Parameters:

  • Value:

EndsWith (String, Boolean): Boolean

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)

Parameters:

  • Value:
  • IgnoreCase:

Equals (String): Boolean

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)

Parameters:

  • Value:

Equals (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

EqualsIgnoringCase (String): Boolean

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)

Parameters:

  • Value:

EqualsIgnoringCase (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

EqualsIgnoringCaseInvariant (String): Boolean

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)

Parameters:

  • Value:

EqualsIgnoringCaseInvariant (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

FileExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

FileOrFolderExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

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; }

FolderExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

Format (String, array of Object): not nullable String  virtual .NET, .NET Standard 2.0, Cooper, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows, Toffee

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)

Parameters:

  • aFormat:
  • aParams:

Format (String, array of Object): not nullable String ToffeeV2

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

 

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

Parameters:

  • aFormat:
  • aParams:

Format (String, array of RemObjects.Elements.System.Island.Object): not nullable String Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator

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

 

class method Format(aFormat: String; params aParams: array of RemObjects.Elements.System.Island.Object): not nullable String

 

static String! Format(String aFormat, params RemObjects.Elements.System.Island.Object[] aParams)

 

static func Format(_ aFormat: String, _ aParams: RemObjects.Elements.System.Island.Object...) -> 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)

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()

IndexAfterJoinedUnicodeCharacterCoveringIndex

 

method IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex: Int32): Int32

 

Int32 IndexAfterJoinedUnicodeCharacterCoveringIndex(Int32 aIndex)

 

func IndexAfterJoinedUnicodeCharacterCoveringIndex(_ aIndex: Int32) -> Int32

 

Integer IndexAfterJoinedUnicodeCharacterCoveringIndex(Integer aIndex)

Parameters:

  • aIndex:

IndexOf (Char): Int32

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)

Parameters:

  • Value:

IndexOf (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOf (String): Int32

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)

Parameters:

  • Value:

IndexOf (String, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOfAny (array of Char): Int32

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)

Parameters:

  • AnyOf:

IndexOfAny (array of Char, Int32): Int32

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)

Parameters:

  • AnyOf:
  • StartIndex:

IndexOfIgnoringCase (Char): Int32

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)

Parameters:

  • Value:

IndexOfIgnoringCase (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOfIgnoringCase (String): Int32

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)

Parameters:

  • Value:

IndexOfIgnoringCase (String, Int32): Int32

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)

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)

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; }

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; }

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; }

IsIndexInsideOfAJoinedUnicodeCharacter

 

method IsIndexInsideOfAJoinedUnicodeCharacter(aIndex: Int32): Boolean

 

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Int32 aIndex)

 

func IsIndexInsideOfAJoinedUnicodeCharacter(_ aIndex: Int32) -> Boolean

 

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Integer aIndex)

Parameters:

  • aIndex:

IsIndexInsideOfASurrogatePair

 

method IsIndexInsideOfASurrogatePair(aIndex: Int32): Boolean

 

Boolean IsIndexInsideOfASurrogatePair(Int32 aIndex)

 

func IsIndexInsideOfASurrogatePair(_ aIndex: Int32) -> Boolean

 

Boolean IsIndexInsideOfASurrogatePair(Integer aIndex)

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)

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)

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; }

Join (String, not nullable array of String): not nullable String  virtual Cooper, Toffee

Join a string together with aSeparator as separator.

 

static func Join(_ aSeparator: String, _ Values: String...) -> String

 

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

Parameters:

  • aSeparator:
  • Values:

Join (String, not nullable ImmutableList<String>): not nullable String  virtual Cooper, Toffee

Join a string together with aSeparator as separator.

 

static func Join(_ aSeparator: String, _ Values: ImmutableList<String>) -> String

 

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

Parameters:

  • aSeparator:
  • Values:

Join (nullable String, not nullable array of String): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

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

Parameters:

  • aSeparator:
  • Values:

Join (nullable String, not nullable ImmutableList<String>): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

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

Parameters:

  • aSeparator:
  • Values:

LastIndexOf (Char): Int32

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)

Parameters:

  • Value:

LastIndexOf (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

LastIndexOf (String): Int32

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)

Parameters:

  • Value:

LastIndexOf (String, Int32): Int32

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)

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)

Parameters:

  • AnyOf:

LastIndexOfAny (array of Char, Int32): Int32

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)

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; }

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; }

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; }

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; }

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; }

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; }

Length

Returns the length of this string.

 

property Length: Int32 read;

 

Int32 Length { get; }

 

var Length: Int32 { get{} }

 

Integer Length { __get; }

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)

Parameters:

  • aOther:

NetworkServerName

Returns the network server name from a path string.

 

property NetworkServerName: nullable String read;

 

String? NetworkServerName { get; }

 

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

 

String NetworkServerName { __get; }

PadEnd (Int32): String

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

 

method PadEnd(TotalWidth: Int32): String

 

String PadEnd(Int32 TotalWidth)

 

func PadEnd(_ TotalWidth: Int32) -> String

 

String PadEnd(Integer TotalWidth)

Parameters:

  • TotalWidth:

PadEnd (Int32, Char): String

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

 

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

 

String PadEnd(Int32 TotalWidth, Char PaddingChar)

 

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

 

String PadEnd(Integer TotalWidth, Char PaddingChar)

Parameters:

  • TotalWidth:
  • PaddingChar:

PadStart (Int32): String

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

 

method PadStart(TotalWidth: Int32): String

 

String PadStart(Int32 TotalWidth)

 

func PadStart(_ TotalWidth: Int32) -> String

 

String PadStart(Integer TotalWidth)

Parameters:

  • TotalWidth:

PadStart (Int32, Char): String

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

 

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

 

String PadStart(Int32 TotalWidth, Char PaddingChar)

 

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

 

String PadStart(Integer TotalWidth, Char PaddingChar)

Parameters:

  • TotalWidth:
  • PaddingChar:

ParentDirectory

 

property ParentDirectory: nullable String read;

 

String? ParentDirectory { get; }

 

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

 

String ParentDirectory { __get; }

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; }

PathWithoutExtension

Returns this string without extension, treating it as filename.

 

property PathWithoutExtension: String read;

 

String PathWithoutExtension { get; }

 

var PathWithoutExtension: String { get{} }

 

String PathWithoutExtension { __get; }

QuotedIfNeeded

Adds quotes if this string contains whitespace.

 

property QuotedIfNeeded: String read;

 

String QuotedIfNeeded { get; }

 

var QuotedIfNeeded: String { get{} }

 

String QuotedIfNeeded { __get; }

Remove (Int32, Int32): not nullable 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)

Parameters:

  • aStartIndex:
  • aLength:

Remove (String): not nullable String

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)

Parameters:

  • OldValue:

Replace (Int32, Int32, String): not nullable String

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)

Parameters:

  • aStartIndex:
  • aLength:
  • aNewValue:

Replace (String, String): not nullable String

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)

Parameters:

  • OldValue:
  • NewValue:

Split

Split this string on aSeparator.

 

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

 

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

 

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

 

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

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)

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)

Parameters:

  • aSeparator:

StartIndexOfJoinedUnicodeCharacterAtIndex

 

method StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex: Int32): Int32

 

Int32 StartIndexOfJoinedUnicodeCharacterAtIndex(Int32 aIndex)

 

func StartIndexOfJoinedUnicodeCharacterAtIndex(_ aIndex: Int32) -> Int32

 

Integer StartIndexOfJoinedUnicodeCharacterAtIndex(Integer aIndex)

Parameters:

  • aIndex:

StartsWith (Char): Boolean

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)

Parameters:

  • Value:

StartsWith (String): Boolean

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)

Parameters:

  • Value:

StartsWith (String, Boolean): Boolean

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)

Parameters:

  • Value:
  • IgnoreCase:

Substring (Int32): not nullable String

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)

Parameters:

  • StartIndex:

Substring (Int32, Int32): not nullable String

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)

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)

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)

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)

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)

Parameters:

  • aSeparator:

ToByteArray

Converts this string to utf8.

 

method ToByteArray: not nullable array of Byte

 

Byte[]! ToByteArray()

 

func ToByteArray() -> Byte...

 

Byte[]! ToByteArray()

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)

Parameters:

  • aEncoding:

ToCharArray

Convert this string to an array.

 

method ToCharArray: not nullable array of Char

 

Char[]! ToCharArray()

 

func ToCharArray() -> Char...

 

Char[]! ToCharArray()

ToHexString

Convert this string to he.x

 

method ToHexString: String

 

String ToHexString()

 

func ToHexString() -> String

 

String ToHexString()

ToLower

Lowrcase this string in the default locale.

 

method ToLower: not nullable String

 

String! ToLower()

 

func ToLower() -> String

 

String! ToLower()

ToLower (Locale): not nullable 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)

Parameters:

  • aLocale:

ToLowerInvariant

Lowrcase this string in the invariant locale.

 

method ToLowerInvariant: not nullable String

 

String! ToLowerInvariant()

 

func ToLowerInvariant() -> String

 

String! ToLowerInvariant()

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)

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)

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)

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; }

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; }

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; }

ToUnicodeCharacters

Convert this string to utf32 unicode characters.

 

method ToUnicodeCharacters: ImmutableList<UnicodeCharacter>

 

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

 

func ToUnicodeCharacters() -> ImmutableList<UnicodeCharacter>

 

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

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<Int32>

 

ImmutableList<Integer> ToUnicodeCodePointIndices()

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<UnicodeCodePoint>

 

ImmutableList<UnsignedInteger> ToUnicodeCodePoints()

ToUnixPath

Convert this to a unix path.

 

property ToUnixPath: String read;

 

String ToUnixPath { get; }

 

var ToUnixPath: String { get{} }

 

String ToUnixPath { __get; }

ToUnixPathFromWindowsPath

Convert a Windows path to unix path.

 

property ToUnixPathFromWindowsPath: String read;

 

String ToUnixPathFromWindowsPath { get; }

 

var ToUnixPathFromWindowsPath: String { get{} }

 

String ToUnixPathFromWindowsPath { __get; }

ToUpper

Uppercase this string in the default locale.

 

method ToUpper: not nullable String

 

String! ToUpper()

 

func ToUpper() -> String

 

String! ToUpper()

ToUpper (Locale): not nullable 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)

Parameters:

  • aLocale:

ToUpperInvariant

Uppercase this string in the invariant locale.

 

method ToUpperInvariant: not nullable String

 

String! ToUpperInvariant()

 

func ToUpperInvariant() -> String

 

String! ToUpperInvariant()

ToWindowsPath

Convert to a Windows path.

 

property ToWindowsPath: String read;

 

String ToWindowsPath { get; }

 

var ToWindowsPath: String { get{} }

 

String ToWindowsPath { __get; }

ToWindowsPathFromUnixPath

Convert a unix path to a Windows path.

 

property ToWindowsPathFromUnixPath: String read;

 

String ToWindowsPathFromUnixPath { get; }

 

var ToWindowsPathFromUnixPath: String { get{} }

 

String ToWindowsPathFromUnixPath { __get; }

Trim

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

 

method Trim: not nullable String

 

String! Trim()

 

func Trim() -> String

 

String! Trim()

Trim (array of Char): not nullable String

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

 

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

 

String! Trim(Char[] TrimChars)

 

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

 

String! Trim(Char[] TrimChars)

Parameters:

  • TrimChars:

TrimEnd

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

 

method TrimEnd: not nullable String

 

String! TrimEnd()

 

func TrimEnd() -> String

 

String! TrimEnd()

TrimEnd (array of Char): not nullable String

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

 

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

 

String! TrimEnd(Char[] TrimChars)

 

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

 

String! TrimEnd(Char[] TrimChars)

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()

TrimStart

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

 

method TrimStart: not nullable String

 

String! TrimStart()

 

func TrimStart() -> String

 

String! TrimStart()

TrimStart (array of Char): not nullable String

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

 

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

 

String! TrimStart(Char[] TrimChars)

 

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

 

String! TrimStart(Char[] TrimChars)

Parameters:

  • TrimChars:

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)

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)

Parameters:

  • aIndex:

UnixParentDirectory

 

property UnixParentDirectory: nullable String read;

 

String? UnixParentDirectory { get; }

 

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

 

String UnixParentDirectory { __get; }

WhiteSpaceCharacters

List of whitespace characters.

 

class var WhiteSpaceCharacters: array of Char;

 

static Char[] WhiteSpaceCharacters

 

static var WhiteSpaceCharacters: Char...

 

static Char[] WhiteSpaceCharacters

WindowsParentDirectory

 

property WindowsParentDirectory: nullable String read;

 

String? WindowsParentDirectory { get; }

 

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

 

String WindowsParentDirectory { __get; }

 

WhiteSpaceCharacters

List of whitespace characters.

 

class var WhiteSpaceCharacters: array of Char;

 

static Char[] WhiteSpaceCharacters

 

static var WhiteSpaceCharacters: Char...

 

static Char[] WhiteSpaceCharacters

 

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; }

FileExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

FileOrFolderExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

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; }

FolderExists .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, 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; }

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; }

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; }

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; }

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; }

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; }

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; }

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; }

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; }

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; }

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; }

Length

Returns the length of this string.

 

property Length: Int32 read;

 

Int32 Length { get; }

 

var Length: Int32 { get{} }

 

Integer Length { __get; }

NetworkServerName

Returns the network server name from a path string.

 

property NetworkServerName: nullable String read;

 

String? NetworkServerName { get; }

 

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

 

String NetworkServerName { __get; }

ParentDirectory

 

property ParentDirectory: nullable String read;

 

String? ParentDirectory { get; }

 

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

 

String ParentDirectory { __get; }

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; }

PathWithoutExtension

Returns this string without extension, treating it as filename.

 

property PathWithoutExtension: String read;

 

String PathWithoutExtension { get; }

 

var PathWithoutExtension: String { get{} }

 

String PathWithoutExtension { __get; }

QuotedIfNeeded

Adds quotes if this string contains whitespace.

 

property QuotedIfNeeded: String read;

 

String QuotedIfNeeded { get; }

 

var QuotedIfNeeded: String { get{} }

 

String QuotedIfNeeded { __get; }

ToPathWithLocalFolderPrefixIfRelative

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

 

property ToPathWithLocalFolderPrefixIfRelative: String read;

 

String ToPathWithLocalFolderPrefixIfRelative { get; }

 

var ToPathWithLocalFolderPrefixIfRelative: String { get{} }

 

String ToPathWithLocalFolderPrefixIfRelative { __get; }

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; }

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; }

ToUnixPath

Convert this to a unix path.

 

property ToUnixPath: String read;

 

String ToUnixPath { get; }

 

var ToUnixPath: String { get{} }

 

String ToUnixPath { __get; }

ToUnixPathFromWindowsPath

Convert a Windows path to unix path.

 

property ToUnixPathFromWindowsPath: String read;

 

String ToUnixPathFromWindowsPath { get; }

 

var ToUnixPathFromWindowsPath: String { get{} }

 

String ToUnixPathFromWindowsPath { __get; }

ToWindowsPath

Convert to a Windows path.

 

property ToWindowsPath: String read;

 

String ToWindowsPath { get; }

 

var ToWindowsPath: String { get{} }

 

String ToWindowsPath { __get; }

ToWindowsPathFromUnixPath

Convert a unix path to a Windows path.

 

property ToWindowsPathFromUnixPath: String read;

 

String ToWindowsPathFromUnixPath { get; }

 

var ToWindowsPathFromUnixPath: String { get{} }

 

String ToWindowsPathFromUnixPath { __get; }

UnixParentDirectory

 

property UnixParentDirectory: nullable String read;

 

String? UnixParentDirectory { get; }

 

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

 

String UnixParentDirectory { __get; }

WindowsParentDirectory

 

property WindowsParentDirectory: nullable String read;

 

String? WindowsParentDirectory { get; }

 

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

 

String WindowsParentDirectory { __get; }

Empty

Empty string: ''

 

class property Empty: String read;

 

class String Empty { get; }

 

static var Empty: String { get{} }

 

class String Empty { __get; }

 

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)

Parameters:

  • Value1:
  • Value2:

Equals (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

EqualsIgnoringCase (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

EqualsIgnoringCaseInvariant (String, String): Boolean

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)

Parameters:

  • ValueA:
  • ValueB:

Format (String, array of Object): not nullable String  virtual .NET, .NET Standard 2.0, Cooper, Island-Android, Island-Ubuntu, Island-WebAssembly-wasm32, Island-Windows, Toffee

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)

Parameters:

  • aFormat:
  • aParams:

Format (String, array of Object): not nullable String ToffeeV2

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

 

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

Parameters:

  • aFormat:
  • aParams:

Format (String, array of RemObjects.Elements.System.Island.Object): not nullable String Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator

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

 

class method Format(aFormat: String; params aParams: array of RemObjects.Elements.System.Island.Object): not nullable String

 

static String! Format(String aFormat, params RemObjects.Elements.System.Island.Object[] aParams)

 

static func Format(_ aFormat: String, _ aParams: RemObjects.Elements.System.Island.Object...) -> String

Parameters:

  • aFormat:
  • aParams:

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)

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)

Parameters:

  • Value:

Join (String, not nullable array of String): not nullable String  virtual Cooper, Toffee

Join a string together with aSeparator as separator.

 

static func Join(_ aSeparator: String, _ Values: String...) -> String

 

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

Parameters:

  • aSeparator:
  • Values:

Join (String, not nullable ImmutableList<String>): not nullable String  virtual Cooper, Toffee

Join a string together with aSeparator as separator.

 

static func Join(_ aSeparator: String, _ Values: ImmutableList<String>) -> String

 

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

Parameters:

  • aSeparator:
  • Values:

Join (nullable String, not nullable array of String): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

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

Parameters:

  • aSeparator:
  • Values:

Join (nullable String, not nullable ImmutableList<String>): not nullable String .NET, .NET Standard 2.0, Island, ToffeeV2

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)

 

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

Parameters:

  • aSeparator:
  • Values:

 

constructor (array of Byte, Encoding)

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

 

constructor(Value: array of Byte; Encoding: Encoding)

 

String(Byte[] Value, Encoding Encoding)

 

init(_ Value: Byte..., _ Encoding: Encoding)

 

String(Byte[] Value, Encoding Encoding)

Parameters:

  • Value:
  • Encoding:

constructor (array of Char)

Creates a string with Value as content.

 

constructor(Value: array of Char)

 

String(Char[] Value)

 

init(_ Value: Char...)

 

String(Char[] Value)

Parameters:

  • Value:

constructor (array of Char, Int32, Int32)

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)

Parameters:

  • Value:
  • Offset:
  • Count:

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)

Parameters:

  • aCodePoints:

constructor (Char, Int32)

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)

Parameters:

  • aChar:
  • aCount:

constructor (List<nullable UnicodeCodePoint>) Toffee

Creates a string with aCodePoints as content.

 

init(_ aCodePoints: List<nullable UnicodeCodePoint>)

Parameters:

  • aCodePoints:

constructor (List<UnicodeCodePoint>) .NET, .NET Standard 2.0, Island, ToffeeV2

Creates a string with aCodePoints as content.

 

constructor(aCodePoints: List<UnicodeCodePoint>)

 

String(List<UnicodeCodePoint> aCodePoints)

 

init(_ aCodePoints: List<UnicodeCodePoint>)

Parameters:

  • aCodePoints:

constructor (List<UnsignedInteger>) Cooper

Creates a string with aCodePoints as content.

 

constructor(aCodePoints: List<UnsignedInteger>)

 

String(List<UnsignedInteger> aCodePoints)

 

init(_ aCodePoints: List<UnsignedInteger>)

 

String(List<UnsignedInteger> aCodePoints)

Parameters:

  • aCodePoints:

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)

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)

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)

Parameters:

  • aPaths:

Capitalize

Uppercase this with the default locale.

 

method Capitalize: not nullable String

 

String! Capitalize()

 

func Capitalize() -> String

 

String! Capitalize()

Capitalize (Locale): not nullable 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)

Parameters:

  • aLocale:

CapitalizeInvariant

Uppercase this with the invariant locale.

 

method CapitalizeInvariant: not nullable String

 

String! CapitalizeInvariant()

 

func CapitalizeInvariant() -> String

 

String! CapitalizeInvariant()

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)

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)

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)

Parameters:

  • Value:

ContainsAny (array of Char): Boolean

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)

Parameters:

  • AnyOf:

ContainsAny (array of Char, Int32): Boolean

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)

Parameters:

  • AnyOf:
  • aStartIndex:

ContainsAnyNonASCII

Returns true if the string contains an character > 127.

 

method ContainsAnyNonASCII: Boolean

 

Boolean ContainsAnyNonASCII()

 

func ContainsAnyNonASCII() -> Boolean

 

Boolean ContainsAnyNonASCII()

ContainsAnyNonASCII (Int32): 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)

Parameters:

  • aStartIndex:

ContainsOnly (array of Char): Boolean

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)

Parameters:

  • AnyOf:

ContainsOnly (array of Char, Int32): Boolean

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)

Parameters:

  • AnyOf:
  • aStartIndex:

EndsWith (Char): Boolean

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)

Parameters:

  • Value:

EndsWith (String): Boolean

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)

Parameters:

  • Value:

EndsWith (String, Boolean): Boolean

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)

Parameters:

  • Value:
  • IgnoreCase:

Equals (String): Boolean

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)

Parameters:

  • Value:

EqualsIgnoringCase (String): Boolean

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)

Parameters:

  • Value:

EqualsIgnoringCaseInvariant (String): Boolean

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)

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)

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()

IndexAfterJoinedUnicodeCharacterCoveringIndex

 

method IndexAfterJoinedUnicodeCharacterCoveringIndex(aIndex: Int32): Int32

 

Int32 IndexAfterJoinedUnicodeCharacterCoveringIndex(Int32 aIndex)

 

func IndexAfterJoinedUnicodeCharacterCoveringIndex(_ aIndex: Int32) -> Int32

 

Integer IndexAfterJoinedUnicodeCharacterCoveringIndex(Integer aIndex)

Parameters:

  • aIndex:

IndexOf (Char): Int32

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)

Parameters:

  • Value:

IndexOf (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOf (String): Int32

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)

Parameters:

  • Value:

IndexOf (String, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOfAny (array of Char): Int32

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)

Parameters:

  • AnyOf:

IndexOfAny (array of Char, Int32): Int32

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)

Parameters:

  • AnyOf:
  • StartIndex:

IndexOfIgnoringCase (Char): Int32

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)

Parameters:

  • Value:

IndexOfIgnoringCase (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

IndexOfIgnoringCase (String): Int32

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)

Parameters:

  • Value:

IndexOfIgnoringCase (String, Int32): Int32

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)

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)

Parameters:

  • aIndex:
  • aNewValue:

IsIndexInsideOfAJoinedUnicodeCharacter

 

method IsIndexInsideOfAJoinedUnicodeCharacter(aIndex: Int32): Boolean

 

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Int32 aIndex)

 

func IsIndexInsideOfAJoinedUnicodeCharacter(_ aIndex: Int32) -> Boolean

 

Boolean IsIndexInsideOfAJoinedUnicodeCharacter(Integer aIndex)

Parameters:

  • aIndex:

IsIndexInsideOfASurrogatePair

 

method IsIndexInsideOfASurrogatePair(aIndex: Int32): Boolean

 

Boolean IsIndexInsideOfASurrogatePair(Int32 aIndex)

 

func IsIndexInsideOfASurrogatePair(_ aIndex: Int32) -> Boolean

 

Boolean IsIndexInsideOfASurrogatePair(Integer aIndex)

Parameters:

  • aIndex:

LastIndexOf (Char): Int32

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)

Parameters:

  • Value:

LastIndexOf (Char, Int32): Int32

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)

Parameters:

  • Value:
  • StartIndex:

LastIndexOf (String): Int32

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)

Parameters:

  • Value:

LastIndexOf (String, Int32): Int32

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)

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)

Parameters:

  • AnyOf:

LastIndexOfAny (array of Char, Int32): Int32

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)

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)

Parameters:

  • aOther:

PadEnd (Int32): String

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

 

method PadEnd(TotalWidth: Int32): String

 

String PadEnd(Int32 TotalWidth)

 

func PadEnd(_ TotalWidth: Int32) -> String

 

String PadEnd(Integer TotalWidth)

Parameters:

  • TotalWidth:

PadEnd (Int32, Char): String

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

 

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

 

String PadEnd(Int32 TotalWidth, Char PaddingChar)

 

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

 

String PadEnd(Integer TotalWidth, Char PaddingChar)

Parameters:

  • TotalWidth:
  • PaddingChar:

PadStart (Int32): String

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

 

method PadStart(TotalWidth: Int32): String

 

String PadStart(Int32 TotalWidth)

 

func PadStart(_ TotalWidth: Int32) -> String

 

String PadStart(Integer TotalWidth)

Parameters:

  • TotalWidth:

PadStart (Int32, Char): String

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

 

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

 

String PadStart(Int32 TotalWidth, Char PaddingChar)

 

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

 

String PadStart(Integer TotalWidth, Char PaddingChar)

Parameters:

  • TotalWidth:
  • PaddingChar:

Remove (Int32, Int32): not nullable 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)

Parameters:

  • aStartIndex:
  • aLength:

Remove (String): not nullable String

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)

Parameters:

  • OldValue:

Replace (Int32, Int32, String): not nullable String

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)

Parameters:

  • aStartIndex:
  • aLength:
  • aNewValue:

Replace (String, String): not nullable String

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)

Parameters:

  • OldValue:
  • NewValue:

Split

Split this string on aSeparator.

 

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

 

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

 

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

 

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

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)

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)

Parameters:

  • aSeparator:

StartIndexOfJoinedUnicodeCharacterAtIndex

 

method StartIndexOfJoinedUnicodeCharacterAtIndex(aIndex: Int32): Int32

 

Int32 StartIndexOfJoinedUnicodeCharacterAtIndex(Int32 aIndex)

 

func StartIndexOfJoinedUnicodeCharacterAtIndex(_ aIndex: Int32) -> Int32

 

Integer StartIndexOfJoinedUnicodeCharacterAtIndex(Integer aIndex)

Parameters:

  • aIndex:

StartsWith (Char): Boolean

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)

Parameters:

  • Value:

StartsWith (String): Boolean

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)

Parameters:

  • Value:

StartsWith (String, Boolean): Boolean

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)

Parameters:

  • Value:
  • IgnoreCase:

Substring (Int32): not nullable String

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)

Parameters:

  • StartIndex:

Substring (Int32, Int32): not nullable String

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)

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)

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)

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)

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)

Parameters:

  • aSeparator:

ToByteArray

Converts this string to utf8.

 

method ToByteArray: not nullable array of Byte

 

Byte[]! ToByteArray()

 

func ToByteArray() -> Byte...

 

Byte[]! ToByteArray()

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)

Parameters:

  • aEncoding:

ToCharArray

Convert this string to an array.

 

method ToCharArray: not nullable array of Char

 

Char[]! ToCharArray()

 

func ToCharArray() -> Char...

 

Char[]! ToCharArray()

ToHexString

Convert this string to he.x

 

method ToHexString: String

 

String ToHexString()

 

func ToHexString() -> String

 

String ToHexString()

ToLower

Lowrcase this string in the default locale.

 

method ToLower: not nullable String

 

String! ToLower()

 

func ToLower() -> String

 

String! ToLower()

ToLower (Locale): not nullable 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)

Parameters:

  • aLocale:

ToLowerInvariant

Lowrcase this string in the invariant locale.

 

method ToLowerInvariant: not nullable String

 

String! ToLowerInvariant()

 

func ToLowerInvariant() -> String

 

String! ToLowerInvariant()

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)

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)

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)

Parameters:

  • aBasePath:

ToUnicodeCharacters

Convert this string to utf32 unicode characters.

 

method ToUnicodeCharacters: ImmutableList<UnicodeCharacter>

 

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

 

func ToUnicodeCharacters() -> ImmutableList<UnicodeCharacter>

 

ImmutableList<UnicodeCharacter> ToUnicodeCharacters()

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<Int32>

 

ImmutableList<Integer> ToUnicodeCodePointIndices()

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<UnicodeCodePoint>

 

ImmutableList<UnsignedInteger> ToUnicodeCodePoints()

ToUpper

Uppercase this string in the default locale.

 

method ToUpper: not nullable String

 

String! ToUpper()

 

func ToUpper() -> String

 

String! ToUpper()

ToUpper (Locale): not nullable 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)

Parameters:

  • aLocale:

ToUpperInvariant

Uppercase this string in the invariant locale.

 

method ToUpperInvariant: not nullable String

 

String! ToUpperInvariant()

 

func ToUpperInvariant() -> String

 

String! ToUpperInvariant()

Trim

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

 

method Trim: not nullable String

 

String! Trim()

 

func Trim() -> String

 

String! Trim()

Trim (array of Char): not nullable String

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

 

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

 

String! Trim(Char[] TrimChars)

 

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

 

String! Trim(Char[] TrimChars)

Parameters:

  • TrimChars:

TrimEnd

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

 

method TrimEnd: not nullable String

 

String! TrimEnd()

 

func TrimEnd() -> String

 

String! TrimEnd()

TrimEnd (array of Char): not nullable String

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

 

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

 

String! TrimEnd(Char[] TrimChars)

 

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

 

String! TrimEnd(Char[] TrimChars)

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()

TrimStart

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

 

method TrimStart: not nullable String

 

String! TrimStart()

 

func TrimStart() -> String

 

String! TrimStart()

TrimStart (array of Char): not nullable String

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

 

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

 

String! TrimStart(Char[] TrimChars)

 

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

 

String! TrimStart(Char[] TrimChars)

Parameters:

  • TrimChars:

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)

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)

Parameters:

  • aIndex: