ToString

Description

The ToString() method returns a string representing the array structure and its elements. By default, arrays are enclosed with curly braces and elements are comma-separated. Object types are represented as “[Object]”. Set the PrettyPrint argument to True to format the returned string with indentation for easier viewing of long or nested arrays.

Syntax

expression.ToString([PrettyPrint], [Separator], [OpeningDelimiter], [ClosingDelimiter], [QuoteStrings])

Parameters

Name: PrettyPrint
Type: Boolean
Necessity: Optional
Description: Set to true to format the returned string for easier viewing.

Name: Separator
Type: String
Necessity: Optional
Description: If provided, the string passed to separator will be used to separate individual elements within the array. If ommitted, the default character of , will be used.

Name: OpeningDelimiter
Type: String
Necessity: Optional
Description: If provided, the string passed to OpeningDelimiter will be used to mark the beginning of arrays. If ommitted, the default character of { will be used.

Name: ClosingDelimiter
Type: String
Necessity: Optional
Description: If provided, the string passed to ClosingDelimiter will be used to mark the beginning of arrays. If ommitted, the default character of } will be used.

Name: QuoteStrings
Type: Boolean
Necessity: Optional
Description: If true, any string values stored in the array will additionally be enclosed by opening and closing quotation marks (").

Returns

Type: String
Description: A string representing the array structure and its elements.

Example

Public Sub ToStringExample()
    Dim result As String
    Dim MyArray As BetterArray
    Set MyArray = New BetterArray

    MyArray.Push "Banana", "Orange", "Apple", "Mango"
    result = MyArray.ToString
    Debug.Print result
    ' expected output:
    ' result = "{Banana,Orange,Apple,Mango}"
End Sub

Back to Docs