A class for more sophisticated array handling than the VBScript built-in arrays allow for. Of course there's System.Collections.ArrayList, but I was aiming for something that a) would not require .NET and b) could easily be used as a queue or stack as well as a "regular" array.
1.0, 2011-01-02
Ansgar Wiechers <ansgar.wiechers@planetcobalt.net>
http://msdn.microsoft.com/en-us/library/system.collections.arraylist.aspx
Get or set the first element of the CArray.
Item(index) (Default)
Get or set the element at the given index of the CArray.
Initialize the CArray with data or get all elements from the CArray.
Get or set the last element of the CArray.
Add(element)
Add the given element at the end of the CArray.
AllIndexOf(element)
Return a CArray with all indexes on which the given element occurs in the CArray.
Append(arr)
Append each element of the given array or CArray to the end of this CArray.
Clear()
Remove all elements from the CArray.
Count()
Return the number of elements in this CArray.
Exists(element)
Indicate whether the given element does or doesn't exist in this CArray.
Flatten()
Transform a multi-dimensional CArray into a one-dimensional CArray by expanding nested arrays.
GetSlice(first, last)
Return a slice (sub-array) from this CArray.
IndexOf(element)
Return the index of the first occurrance of the given element in the CArray.
InsertBefore(index, element)
Insert the given element into the CArray before the given index.
InsertFirst(element)
Insert the given element as the first element.
InsertLast(element)
Insert the given element as the last element.
LastIndexOf(element)
Return the index of the last occurrance of the given element in the CArray.
Pop()
Remove the last element from the CArray and return it to the caller.
Push(element)
Insert the given element as the last element.
Remove(index)
Remove the element at the given index from the CArray and return it to the caller.
Remove the first element from the CArray and return it to the caller.
Remove the first element from the CArray and return it to the caller.
RemoveSlice(first, last)
Remove a slice (sub-array) from this CArray and return it to the caller.
Reverse()
Revert the order of the elements in the CArray.
Sort()
Sort the CArray in ascending order.
ToArray()
Return the elements of the CArray as a plain VBScript array.
Return the index of this CArray's upper boundary.
First (read-write)
Get or set the first element of the CArray. If no first element exists (i.e. the CArray does not contain any elements), an error is raised. Getting the first element does not remove the element from the CArray.
Index out of bounds. (9)
Item(index) (read-write, default)
Get or set the element at the given index of the CArray. If the index is outside the CArray's boundaries, an error is raised. Getting an element does not remove the element from the CArray.
Index out of bounds. (9)
Items (read-write)
Initialize the CArray with data or get all elements from the CArray. When (Re-)initializing the CArray with (new) data, any data already present in the CArray is discarded. Data that is neither an array nor a CArray is treated as an array with size 1.
Last (read-write)
Get or set the last element of the CArray. If no last element exists (i.e. the CArray does not contain any elements), an error is raised. Getting the last element does not remove the element from the CArray.
Index out of bounds. (9)
Public Add(element)
Add the given element at the end of the CArray. Array and CArray elements are added as nested items. To concatenate an array or CArray with this CArray, use Append() instead.
element - The element to add.
Public AllIndexOf(element)
Return a CArray with all indexes on which the given element occurs in the CArray. The function does not recurse into nested arrays.
element - The element for which to check.
CArray with all indexes for the given element.
Public Append(arr)
Append each element of the given array or CArray to the end of this CArray. Arguments that are not an array or CArray are simply added to the CArray (you could as well use Add() in this case).
arr - The array or CArray to append.
Public Clear()
Remove all elements from the CArray.
Public Count()
Return the number of elements in this CArray.
The number of elements in the CArray.
Public Exists(element)
Indicate whether the given element does or doesn't exist in this CArray. The function does not recurse into nested arrays.
element - The element to check for.
True if the element is found in the CArray, otherwise False.
Public Flatten()
Transform a multi-dimensional CArray into a one-dimensional CArray by expanding nested arrays.
Public GetSlice(first, last)
Return a slice (sub-array) from this CArray. The interval defined by the indexes is left-closed right-open (i.e. the element referred to by the last index is not included with the slice).
If both index values are outside the CArray's boundaries, or if the last index is greater than or equal to the first index, an empty CArray is returned. Negative indexes are allowed and refer to elements counted from the upper boundary of the array, starting with -1. Parameters can be Null and are then interpreted as the CArray's lower or upper boundary respectively.
first - Index of the beginning of the slice (included).
last - Index of the end of the slice (excluded).
A slice from the CArray. The slice is also a CArray.
Public IndexOf(element)
Return the index of the first occurrance of the given element in the CArray. If no occurrance is found, the return value is Null. The function does not recurse into nested arrays.
element - The element to check for.
The index of the first occurrance of element or Null.
Public InsertBefore(index, element)
Insert the given element into the CArray before the given index.
index - Index before which the element should be inserted.
element - Element to insert into the CArray.
Index out of bounds. (9)
Public InsertFirst(element)
Insert the given element as the first element. This is basically an alias for InsertBefore(0, element) to have coherent method names for using CArray as a queue.
element - Element to insert into the CArray.
Public InsertLast(element)
Insert the given element as the last element. This is basically an alias for Add() to have coherent method names for using CArray as a queue.
element - Element to add to the CArray.
Public LastIndexOf(element)
Return the index of the last occurrance of the given element in the CArray. If no occurrance is found, the return value is Null. The function does not recurse into nested arrays.
element - The element to check for.
The index of the last occurrance of element or Null.
Public Pop()
Remove the last element from the CArray and return it to the caller. If the CArray does not contain any elements, an error is raised. This is basically an alias for Remove(CArray.UpperBound) to have coherent method names for using CArray as a stack.
The element that was last in the CArray.
Index out of bounds. (9)
Public Push(element)
Insert the given element as the last element. This is basically an alias for Add() to have coherent method names for using CArray as a stack.
element - Element to add to the CArray.
Public Remove(index)
Remove the element at the given index from the CArray and return it to the caller. If the given index is outside the boundaries of the CArray, an error is raised.
index - The index of the element to remove.
The element that was removed from the CArray.
Index out of bounds. (9)
Public RemoveFirst()
Remove the first element from the CArray and return it to the caller. If the CArray does not contain any elements, an error is raised. This is basically an alias for Remove(0) to have coherent method names for using CArray as a queue.
The element that was first in the CArray.
Index out of bounds. (9)
Public RemoveLast()
Remove the first element from the CArray and return it to the caller. If the CArray does not contain any elements, an error is raised. This is basically an alias for Remove(CArray.UpperBound) to have coherent method names for using CArray as a queue.
The element that was last in the CArray.
Index out of bounds. (9)
Public RemoveSlice(first, last)
Remove a slice (sub-array) from this CArray and return it to the caller. The interval defined by the indexes is left-closed right-open (i.e. the element referred to by the last index is not included with the slice).
If both index values are outside the CArray's boundaries, or if the last index is greater than or equal to the first index, nothing is removed and an empty CArray is returned. Negative indexes are allowed and refer to elements counted from the upper boundary of the array, starting with -1. Parameters can be Null and are then interpreted as the CArray's lower or upper boundary respectively.
first - Index of the beginning of the slice (included).
last - Index of the end of the slice (excluded).
The slice removed from the CArray. This slice is also a CArray.
Public Reverse()
Revert the order of the elements in the CArray.
Public Sort()
Sort the CArray in ascending order. If the CArray contains any complex data types (like nested arrays or objects) an error will be raised. Arrays will raise error 10 (type mismatch), while objects will raise error 438 (property or method not supported).
Type mismatch. (10)
Object doesn't support this property or method. (438)
http://msdn.microsoft.com/en-us/library/xe43cc8d.aspx
Public ToArray()
Return the elements of the CArray as a plain VBScript array.
Array with the elements of the CArray.
Public UpperBound()
Return the index of this CArray's upper boundary.
The index of the CArray's upper boundary.