String
Overview
String is the class for the Island string implementation, basically the type used for a sequence of characters. String itself is immutable.
Location
- Reference: Island.fx
- Namespace: RemObjects.Elements.System
constructor (declared in Object)
constructor
String()
init()
String()
Sub New()
Compare
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- aLeft:
- aRight:
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- a:
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- Value:
CompareToIgnoreCase
Compares two strings, returns 0 if equal, -1 if less, 1 if more, ignoring the case.
Parameters:
- Value:
Contains
Check if a string is contained in another string.
Parameters:
- Value:
CopyTo
method CopyTo(SourceIndex: Int32; destination: array of Char; DestinationIndex: Int32; Count: Int32)
Parameters:
- SourceIndex:
- destination:
- DestinationIndex:
- Count:
EndsWith
Returns true if a string ends with a value.
Parameters:
- Value:
- aInvariant:
Copy a string to an array of char.
Parameters:
- aOther:
Copy a string to an array of char.
Parameters:
- aOther:
EqualsIgnoreCase
Copy a string to an array of char.
Parameters:
- aOther:
EqualsIgnoreCaseInvariant
Copy a string to an array of char.
Parameters:
- aOther:
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
FirstChar
Returns a pointer to the first char of this string.
property FirstChar: ^Char read;
Char* FirstChar { get; }
var FirstChar: UnsafeMutablePointer<Char> { get{} }
Char* FirstChar { __get; }
ReadOnly Property FirstChar() As Ptr(Of Char)
Format
Format a string given a format string (.net style formatting).
Parameters:
- aFormat:
- aArguments:
FromChar
Creates a string from a char.
Parameters:
- c:
FromCharArray
Creates a string from a char array.
Parameters:
- aArray:
Parameters:
- c:
Parameters:
- c:
- aCharCount:
Creates a string from an unicode char pointer.
Parameters:
- c:
Creates a string from an unicode char pointer.
Parameters:
- c:
- aCharCount:
FromRepeatedChar
Creates a string from a repeated character.
Parameters:
- c:
- aCharCount:
GetEnumerator
Returns an iterator for this class.
method GetEnumerator: IEnumerator<Char>
IEnumerator<Char> GetEnumerator()
func GetEnumerator() -> IEnumerator<Char>
IEnumerator<Char> GetEnumerator()
Function GetEnumerator() As IEnumerator<Char>
GetHashCode override virtual
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
Returns the index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
Returns the index of the substring Value in this string, or -1 if it's not found; starts searching at aStartfromIndex.
Parameters:
- Value:
- aStartFromIndex:
IndexOfAny
Returns the index of any char in the array or -1 if it's not there.
Parameters:
- anyOf:
Insert
Insert a string at the given position and return the new strnig
Parameters:
- aIndex:
- aNewValue:
IsNullOrEmpty
Check if a string is null or empty.
Parameters:
- value:
Item
property Item[i: Index]: Char read;
Char Item[Index i] { get; }
subscript Item(_ i: Index) -> Char { get{} }
Char Item[Index i] { __get; }
ReadOnly Property Item(i As Index) As Char
Item
Accessor for this string by index.
Item
property Item[r: Range]: String read;
String Item[Range r] { get; }
subscript Item(_ r: Range) -> String { get{} }
String Item[Range r] { __get; }
ReadOnly Property Item(r As Range) As String
Join a sequence of strings together with a given seperator.
Parameters:
- Separator:
- Value:
Join a sequence of strings together with a given seperator.
Parameters:
- Separator:
- Value:
Join a sequence of strings together with a given seperator.
class method Join(Separator: String; Value: array of String; StartIndex: Int32; Count: Int32): String
Parameters:
- Separator:
- Value:
- StartIndex:
- Count:
Join (String, IEnumerable<String>): String
Join a sequence of strings together with a given seperator.
class method Join(Separator: String; Value: IEnumerable<String>): String
static String Join(String Separator, IEnumerable<String> Value)
static func Join(_ Separator: String, _ Value: IEnumerable<String>) -> String
static String Join(String Separator, IEnumerable<String> Value)
Shared Function Join(Separator As String, Value As IEnumerable<String>) As String
Parameters:
- Separator:
- Value:
Join<T>
Join a sequence of objects together with a given seperator.
class method Join<T>(Separator: String; Value: IEnumerable<T>): String
static String Join<T>(String Separator, IEnumerable<T> Value)
static func Join<T>(_ Separator: String, _ Value: IEnumerable<T>) -> String
static String Join<T>(String Separator, IEnumerable<T> Value)
Shared Function Join<T>(Separator As String, Value As IEnumerable<T>) As String
Parameters:
- Separator:
- Value:
Returns the last index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
Returns the last index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
- aStartFromIndex:
LastIndexOfAny
Returns the last index of any of the characters in the array in this string, or -1 if it's not found.
Parameters:
- anyOf:
Length
Returns the length of this string.
property Length: Int32 read;
Int32 Length { get; }
var Length: Int32 { get{} }
Int32 Length { __get; }
ReadOnly Property Length() As Int32
Adds spacing to the end of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
Adds spacing to the end of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
- PaddingChar:
Adds spacing to the start of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
Adds spacing to the start of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
- PaddingChar:
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
Remove from the string from startindex on.
Parameters:
- StartIndex:
Remove from the string from startindex on, for a given length.
Parameters:
- StartIndex:
- Count:
Replace
Replace a substring in a string with another value.
Parameters:
- OldValue:
- NewValue:
Split
Split a string on a given separator.
Parameters:
- Separator:
- aRemoveEmptyEntries:
- aMax:
StartsWith
Returns if a string starts with a value.
Parameters:
- Value:
- aInvariant:
Substring (Range): String
method Substring(aRange: Range): String
String Substring(Range aRange)
func Substring(_ aRange: Range) -> String
String Substring(Range aRange)
Function Substring(aRange As Range) As String
Parameters:
- aRange:
Returns a substring of this string.
Parameters:
- StartIndex:
Returns a substring of this string.
Parameters:
- StartIndex:
- aLength:
ToAnsiChars
Convert this string to an array of ansichar.
Parameters:
- aNullTerminate:
Convert this string to an array of char.
Parameters:
- aNullTerminate:
Convert this string to an array of char.
Parameters:
- StartIndex:
- aLength:
- aNullTerminate:
Lowercase this string.
Parameters:
- aInvariant:
Lowercase this string.
Parameters:
- aLocale:
ToLowerInvariant
Lowercase this string.
method ToLowerInvariant: String
String ToLowerInvariant()
func ToLowerInvariant() -> String
String ToLowerInvariant()
Function ToLowerInvariant() As String
ToString override virtual
Returns itself.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
Uppercase this string.
Parameters:
- aInvariant:
Uppercase this string.
Parameters:
- aLocale:
ToUpperInvariant
Uppercase this string.
method ToUpperInvariant: String
String ToUpperInvariant()
func ToUpperInvariant() -> String
String ToUpperInvariant()
Function ToUpperInvariant() As String
Trim
Trim this string at the start and end of whitespace characters.
Trim this string at the start and end of aChars characters.
Parameters:
- aChars:
TrimEnd
Trim this string at the end of whitespace characters.
method TrimEnd: String
String TrimEnd()
func TrimEnd() -> String
String TrimEnd()
Function TrimEnd() As String
Trim this string at the end of aChars characters.
Parameters:
- aChars:
TrimStart
Trim this string at the start of whitespace characters.
method TrimStart: String
String TrimStart()
func TrimStart() -> String
String TrimStart()
Function TrimStart() As String
Trim this string at the start of aChars characters.
Parameters:
- aChars:
FirstChar
Returns a pointer to the first char of this string.
property FirstChar: ^Char read;
Char* FirstChar { get; }
var FirstChar: UnsafeMutablePointer<Char> { get{} }
Char* FirstChar { __get; }
ReadOnly Property FirstChar() As Ptr(Of Char)
Item
property Item[i: Index]: Char read;
Char Item[Index i] { get; }
subscript Item(_ i: Index) -> Char { get{} }
Char Item[Index i] { __get; }
ReadOnly Property Item(i As Index) As Char
Item
Accessor for this string by index.
Item
property Item[r: Range]: String read;
String Item[Range r] { get; }
subscript Item(_ r: Range) -> String { get{} }
String Item[Range r] { __get; }
ReadOnly Property Item(r As Range) As String
Length
Returns the length of this string.
Compare
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- aLeft:
- aRight:
Format
Format a string given a format string (.net style formatting).
Parameters:
- aFormat:
- aArguments:
FromChar
Creates a string from a char.
Parameters:
- c:
FromCharArray
Creates a string from a char array.
Parameters:
- aArray:
Parameters:
- c:
Parameters:
- c:
- aCharCount:
Creates a string from an unicode char pointer.
Parameters:
- c:
Creates a string from an unicode char pointer.
Parameters:
- c:
- aCharCount:
FromRepeatedChar
Creates a string from a repeated character.
Parameters:
- c:
- aCharCount:
IsNullOrEmpty
Check if a string is null or empty.
Parameters:
- value:
Join a sequence of strings together with a given seperator.
Parameters:
- Separator:
- Value:
Join a sequence of strings together with a given seperator.
Parameters:
- Separator:
- Value:
Join a sequence of strings together with a given seperator.
class method Join(Separator: String; Value: array of String; StartIndex: Int32; Count: Int32): String
Parameters:
- Separator:
- Value:
- StartIndex:
- Count:
Join (String, IEnumerable<String>): String
Join a sequence of strings together with a given seperator.
class method Join(Separator: String; Value: IEnumerable<String>): String
static String Join(String Separator, IEnumerable<String> Value)
static func Join(_ Separator: String, _ Value: IEnumerable<String>) -> String
static String Join(String Separator, IEnumerable<String> Value)
Shared Function Join(Separator As String, Value As IEnumerable<String>) As String
Parameters:
- Separator:
- Value:
Join<T>
Join a sequence of objects together with a given seperator.
class method Join<T>(Separator: String; Value: IEnumerable<T>): String
static String Join<T>(String Separator, IEnumerable<T> Value)
static func Join<T>(_ Separator: String, _ Value: IEnumerable<T>) -> String
static String Join<T>(String Separator, IEnumerable<T> Value)
Shared Function Join<T>(Separator As String, Value As IEnumerable<T>) As String
Parameters:
- Separator:
- Value:
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
constructor (declared in Object)
constructor
String()
init()
String()
Sub New()
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- a:
Compares two strings, returns 0 if equal, -1 if less, 1 if more.
Parameters:
- Value:
CompareToIgnoreCase
Compares two strings, returns 0 if equal, -1 if less, 1 if more, ignoring the case.
Parameters:
- Value:
Contains
Check if a string is contained in another string.
Parameters:
- Value:
CopyTo
method CopyTo(SourceIndex: Int32; destination: array of Char; DestinationIndex: Int32; Count: Int32)
Parameters:
- SourceIndex:
- destination:
- DestinationIndex:
- Count:
EndsWith
Returns true if a string ends with a value.
Parameters:
- Value:
- aInvariant:
Copy a string to an array of char.
Parameters:
- aOther:
Copy a string to an array of char.
Parameters:
- aOther:
EqualsIgnoreCase
Copy a string to an array of char.
Parameters:
- aOther:
EqualsIgnoreCaseInvariant
Copy a string to an array of char.
Parameters:
- aOther:
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
GetEnumerator
Returns an iterator for this class.
method GetEnumerator: IEnumerator<Char>
IEnumerator<Char> GetEnumerator()
func GetEnumerator() -> IEnumerator<Char>
IEnumerator<Char> GetEnumerator()
Function GetEnumerator() As IEnumerator<Char>
GetHashCode override virtual
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
Returns the index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
Returns the index of the substring Value in this string, or -1 if it's not found; starts searching at aStartfromIndex.
Parameters:
- Value:
- aStartFromIndex:
IndexOfAny
Returns the index of any char in the array or -1 if it's not there.
Parameters:
- anyOf:
Insert
Insert a string at the given position and return the new strnig
Parameters:
- aIndex:
- aNewValue:
Returns the last index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
Returns the last index of the substring Value in this string, or -1 if it's not found.
Parameters:
- Value:
- aStartFromIndex:
LastIndexOfAny
Returns the last index of any of the characters in the array in this string, or -1 if it's not found.
Parameters:
- anyOf:
Adds spacing to the end of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
Adds spacing to the end of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
- PaddingChar:
Adds spacing to the start of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
Adds spacing to the start of a string so it is at least TotalWidth.
Parameters:
- TotalWidth:
- PaddingChar:
Remove from the string from startindex on.
Parameters:
- StartIndex:
Remove from the string from startindex on, for a given length.
Parameters:
- StartIndex:
- Count:
Replace
Replace a substring in a string with another value.
Parameters:
- OldValue:
- NewValue:
Split
Split a string on a given separator.
Parameters:
- Separator:
- aRemoveEmptyEntries:
- aMax:
StartsWith
Returns if a string starts with a value.
Parameters:
- Value:
- aInvariant:
Substring (Range): String
method Substring(aRange: Range): String
String Substring(Range aRange)
func Substring(_ aRange: Range) -> String
String Substring(Range aRange)
Function Substring(aRange As Range) As String
Parameters:
- aRange:
Returns a substring of this string.
Parameters:
- StartIndex:
Returns a substring of this string.
Parameters:
- StartIndex:
- aLength:
ToAnsiChars
Convert this string to an array of ansichar.
Parameters:
- aNullTerminate:
Convert this string to an array of char.
Parameters:
- aNullTerminate:
Convert this string to an array of char.
Parameters:
- StartIndex:
- aLength:
- aNullTerminate:
Lowercase this string.
Parameters:
- aInvariant:
Lowercase this string.
Parameters:
- aLocale:
ToLowerInvariant
Lowercase this string.
method ToLowerInvariant: String
String ToLowerInvariant()
func ToLowerInvariant() -> String
String ToLowerInvariant()
Function ToLowerInvariant() As String
ToString override virtual
Returns itself.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
Uppercase this string.
Parameters:
- aInvariant:
Uppercase this string.
Parameters:
- aLocale:
ToUpperInvariant
Uppercase this string.
method ToUpperInvariant: String
String ToUpperInvariant()
func ToUpperInvariant() -> String
String ToUpperInvariant()
Function ToUpperInvariant() As String
Trim
Trim this string at the start and end of whitespace characters.
Trim this string at the start and end of aChars characters.
Parameters:
- aChars:
TrimEnd
Trim this string at the end of whitespace characters.
method TrimEnd: String
String TrimEnd()
func TrimEnd() -> String
String TrimEnd()
Function TrimEnd() As String
Trim this string at the end of aChars characters.
Parameters:
- aChars:
TrimStart
Trim this string at the start of whitespace characters.
method TrimStart: String
String TrimStart()
func TrimStart() -> String
String TrimStart()
Function TrimStart() As String
Trim this string at the start of aChars characters.
Parameters:
- aChars: