Overview

String builder is a class create strings built out of lots of small parts.

Location

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

constructor

Creates a string builder.

Creates a string builder with a given capacity.

constructor(Capacity: Int32)
StringBuilder(Int32 Capacity)
StringBuilder(Integer Capacity)
Sub New(Capacity As Int32)

Parameters:

  • Capacity:

Creates a string builder with a given String.

constructor(Data: String)
StringBuilder(String Data)
StringBuilder(String Data)

Parameters:

  • Data:

Add to the end of this string builder.

method Append(Value: Char): StringBuilder
StringBuilder Append(Char Value)
func Append(_ Value: Char) -> StringBuilder
StringBuilder Append(Char Value)
Function Append(Value As Char) As StringBuilder

Parameters:

  • Value:

Add this character to the end of this string builder, repeating it.

method Append(Value: Char; RepeatCount: Int32): StringBuilder
StringBuilder Append(Char Value, Int32 RepeatCount)
func Append(_ Value: Char, _ RepeatCount: Int32) -> StringBuilder
StringBuilder Append(Char Value, Integer RepeatCount)
Function Append(Value As Char, RepeatCount As Int32) As StringBuilder

Parameters:

  • Value:
  • RepeatCount:

Add to the end of this string builder.

method Append(Value: nullable String): StringBuilder
StringBuilder Append(String? Value)
// Toffee
func Append(_ Value: String) -> StringBuilder
// ToffeeV2
func Append(_ Value: String?) -> StringBuilder
StringBuilder Append(String Value)
Function Append(Value As String?) As StringBuilder

Parameters:

  • Value:

Add to the end of this string builder.

method Append(Value: nullable String; StartIndex: Int32; Count: Int32): StringBuilder
StringBuilder Append(String? Value, Int32 StartIndex, Int32 Count)
// Toffee
func Append(_ Value: String, _ StartIndex: Int32, _ Count: Int32) -> StringBuilder
// ToffeeV2
func Append(_ Value: String?, _ StartIndex: Int32, _ Count: Int32) -> StringBuilder
StringBuilder Append(String Value, Integer StartIndex, Integer Count)
Function Append(Value As String?, StartIndex As Int32, Count As Int32) As StringBuilder

Parameters:

  • Value:
  • StartIndex:
  • Count:

AppendFormat

Add a formatted string to the end of this string builder.

method AppendFormat(aFormat: String; params aParams: array of Object): StringBuilder
StringBuilder AppendFormat(String aFormat, params Object[] aParams)
func AppendFormat(_ aFormat: String, _ aParams: Object...) -> StringBuilder
StringBuilder AppendFormat(String aFormat, Object[]... aParams)
Function AppendFormat(aFormat As String, ParamArray aParams As Object()) As StringBuilder

Parameters:

  • aFormat:
  • aParams:

AppendLine

Appends a line enter.

method AppendLine: StringBuilder
StringBuilder AppendLine()
func AppendLine() -> StringBuilder
StringBuilder AppendLine()
Function AppendLine() As StringBuilder

Add a formatted string to the end of this string builder, adding a line enter at the end.

method AppendLine(aFormat: nullable String; params aParams: array of Object): StringBuilder
StringBuilder AppendLine(String? aFormat, params Object[] aParams)
// Toffee
func AppendLine(_ aFormat: String, _ aParams: Object...) -> StringBuilder
// ToffeeV2
func AppendLine(_ aFormat: String?, _ aParams: Object...) -> StringBuilder
StringBuilder AppendLine(String aFormat, Object[]... aParams)
Function AppendLine(aFormat As String?, ParamArray aParams As Object()) As StringBuilder

Parameters:

  • aFormat:
  • aParams:

Appends to the end of this string, including a line enter.

method AppendLine(Value: nullable String): StringBuilder
StringBuilder AppendLine(String? Value)
// Toffee
func AppendLine(_ Value: String) -> StringBuilder
// ToffeeV2
func AppendLine(_ Value: String?) -> StringBuilder
StringBuilder AppendLine(String Value)
Function AppendLine(Value As String?) As StringBuilder

Parameters:

  • Value:

Chars

Access the characters in this stringbuilder by index.

property Chars[Index: Int32]: Char read write;
Char Chars[Int32 Index] { get; set; }
subscript Chars(_ Index: Int32) -> Char { get{} set{} }
Char Chars[Integer Index] { __get; __set; }
Property Chars(Index As Int32) As Char

Clear

Clears this stringbuilder.

Delete

Delete a substring from this string.

method Delete(StartIndex: Int32; Count: Int32): StringBuilder
StringBuilder Delete(Int32 StartIndex, Int32 Count)
func Delete(_ StartIndex: Int32, _ Count: Int32) -> StringBuilder
StringBuilder Delete(Integer StartIndex, Integer Count)
Function Delete(StartIndex As Int32, Count As Int32) As StringBuilder

Parameters:

  • StartIndex:
  • Count:

Insert

Insert into this string at Offset.

method Insert(Offset: Int32; Value: String): StringBuilder
StringBuilder Insert(Int32 Offset, String Value)
func Insert(_ Offset: Int32, _ Value: String) -> StringBuilder
StringBuilder Insert(Integer Offset, String Value)
Function Insert(Offset As Int32, Value As String) As StringBuilder

Parameters:

  • Offset:
  • Value:

Length

Returns the length of this stringbuilder.

property Length: Int32 read write;
Int32 Length { get; set; }
var Length: Int32 { get{} set{} }
Integer Length { __get; __set; }
Property Length() As Int32

Replace

Replace a range in this string.

method Replace(StartIndex: Int32; Count: Int32; Value: String): StringBuilder
StringBuilder Replace(Int32 StartIndex, Int32 Count, String Value)
func Replace(_ StartIndex: Int32, _ Count: Int32, _ Value: String) -> StringBuilder
StringBuilder Replace(Integer StartIndex, Integer Count, String Value)
Function Replace(StartIndex As Int32, Count As Int32, Value As String) As StringBuilder

Parameters:

  • StartIndex:
  • Count:
  • Value:

Returns a substring of this string.

method Substring(StartIndex: Int32): String
String Substring(Int32 StartIndex)
func Substring(_ StartIndex: Int32) -> String
String Substring(Integer StartIndex)
Function Substring(StartIndex As Int32) As String

Parameters:

  • StartIndex:

Returns a substring of this string.

method Substring(StartIndex: Int32; Count: Int32): String
String Substring(Int32 StartIndex, Int32 Count)
func Substring(_ StartIndex: Int32, _ Count: Int32) -> String
String Substring(Integer StartIndex, Integer Count)
Function Substring(StartIndex As Int32, Count As Int32) As String

Parameters:

  • StartIndex:
  • Count:

Chars

Access the characters in this stringbuilder by index.

property Chars[Index: Int32]: Char read write;
Char Chars[Int32 Index] { get; set; }
subscript Chars(_ Index: Int32) -> Char { get{} set{} }
Char Chars[Integer Index] { __get; __set; }
Property Chars(Index As Int32) As Char

Length

Returns the length of this stringbuilder.

property Length: Int32 read write;
Int32 Length { get; set; }
var Length: Int32 { get{} set{} }
Integer Length { __get; __set; }
Property Length() As Int32

constructor

Creates a string builder.

Creates a string builder with a given capacity.

constructor(Capacity: Int32)
StringBuilder(Int32 Capacity)
StringBuilder(Integer Capacity)
Sub New(Capacity As Int32)

Parameters:

  • Capacity:

Creates a string builder with a given String.

constructor(Data: String)
StringBuilder(String Data)
StringBuilder(String Data)

Parameters:

  • Data:

Add to the end of this string builder.

method Append(Value: Char): StringBuilder
StringBuilder Append(Char Value)
func Append(_ Value: Char) -> StringBuilder
StringBuilder Append(Char Value)
Function Append(Value As Char) As StringBuilder

Parameters:

  • Value:

Add this character to the end of this string builder, repeating it.

method Append(Value: Char; RepeatCount: Int32): StringBuilder
StringBuilder Append(Char Value, Int32 RepeatCount)
func Append(_ Value: Char, _ RepeatCount: Int32) -> StringBuilder
StringBuilder Append(Char Value, Integer RepeatCount)
Function Append(Value As Char, RepeatCount As Int32) As StringBuilder

Parameters:

  • Value:
  • RepeatCount:

Add to the end of this string builder.

method Append(Value: nullable String): StringBuilder
StringBuilder Append(String? Value)
// Toffee
func Append(_ Value: String) -> StringBuilder
// ToffeeV2
func Append(_ Value: String?) -> StringBuilder
StringBuilder Append(String Value)
Function Append(Value As String?) As StringBuilder

Parameters:

  • Value:

Add to the end of this string builder.

method Append(Value: nullable String; StartIndex: Int32; Count: Int32): StringBuilder
StringBuilder Append(String? Value, Int32 StartIndex, Int32 Count)
// Toffee
func Append(_ Value: String, _ StartIndex: Int32, _ Count: Int32) -> StringBuilder
// ToffeeV2
func Append(_ Value: String?, _ StartIndex: Int32, _ Count: Int32) -> StringBuilder
StringBuilder Append(String Value, Integer StartIndex, Integer Count)
Function Append(Value As String?, StartIndex As Int32, Count As Int32) As StringBuilder

Parameters:

  • Value:
  • StartIndex:
  • Count:

AppendFormat

Add a formatted string to the end of this string builder.

method AppendFormat(aFormat: String; params aParams: array of Object): StringBuilder
StringBuilder AppendFormat(String aFormat, params Object[] aParams)
func AppendFormat(_ aFormat: String, _ aParams: Object...) -> StringBuilder
StringBuilder AppendFormat(String aFormat, Object[]... aParams)
Function AppendFormat(aFormat As String, ParamArray aParams As Object()) As StringBuilder

Parameters:

  • aFormat:
  • aParams:

AppendLine

Appends a line enter.

method AppendLine: StringBuilder
StringBuilder AppendLine()
func AppendLine() -> StringBuilder
StringBuilder AppendLine()
Function AppendLine() As StringBuilder

Add a formatted string to the end of this string builder, adding a line enter at the end.

method AppendLine(aFormat: nullable String; params aParams: array of Object): StringBuilder
StringBuilder AppendLine(String? aFormat, params Object[] aParams)
// Toffee
func AppendLine(_ aFormat: String, _ aParams: Object...) -> StringBuilder
// ToffeeV2
func AppendLine(_ aFormat: String?, _ aParams: Object...) -> StringBuilder
StringBuilder AppendLine(String aFormat, Object[]... aParams)
Function AppendLine(aFormat As String?, ParamArray aParams As Object()) As StringBuilder

Parameters:

  • aFormat:
  • aParams:

Appends to the end of this string, including a line enter.

method AppendLine(Value: nullable String): StringBuilder
StringBuilder AppendLine(String? Value)
// Toffee
func AppendLine(_ Value: String) -> StringBuilder
// ToffeeV2
func AppendLine(_ Value: String?) -> StringBuilder
StringBuilder AppendLine(String Value)
Function AppendLine(Value As String?) As StringBuilder

Parameters:

  • Value:

Clear

Clears this stringbuilder.

Delete

Delete a substring from this string.

method Delete(StartIndex: Int32; Count: Int32): StringBuilder
StringBuilder Delete(Int32 StartIndex, Int32 Count)
func Delete(_ StartIndex: Int32, _ Count: Int32) -> StringBuilder
StringBuilder Delete(Integer StartIndex, Integer Count)
Function Delete(StartIndex As Int32, Count As Int32) As StringBuilder

Parameters:

  • StartIndex:
  • Count:

Insert

Insert into this string at Offset.

method Insert(Offset: Int32; Value: String): StringBuilder
StringBuilder Insert(Int32 Offset, String Value)
func Insert(_ Offset: Int32, _ Value: String) -> StringBuilder
StringBuilder Insert(Integer Offset, String Value)
Function Insert(Offset As Int32, Value As String) As StringBuilder

Parameters:

  • Offset:
  • Value:

Replace

Replace a range in this string.

method Replace(StartIndex: Int32; Count: Int32; Value: String): StringBuilder
StringBuilder Replace(Int32 StartIndex, Int32 Count, String Value)
func Replace(_ StartIndex: Int32, _ Count: Int32, _ Value: String) -> StringBuilder
StringBuilder Replace(Integer StartIndex, Integer Count, String Value)
Function Replace(StartIndex As Int32, Count As Int32, Value As String) As StringBuilder

Parameters:

  • StartIndex:
  • Count:
  • Value:

Returns a substring of this string.

method Substring(StartIndex: Int32): String
String Substring(Int32 StartIndex)
func Substring(_ StartIndex: Int32) -> String
String Substring(Integer StartIndex)
Function Substring(StartIndex As Int32) As String

Parameters:

  • StartIndex:

Returns a substring of this string.

method Substring(StartIndex: Int32; Count: Int32): String
String Substring(Int32 StartIndex, Int32 Count)
func Substring(_ StartIndex: Int32, _ Count: Int32) -> String
String Substring(Integer StartIndex, Integer Count)
Function Substring(StartIndex As Int32, Count As Int32) As String

Parameters:

  • StartIndex:
  • Count: