Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/methods/Fill.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Necessity
: Optional

Description
: The first index of the outermost array to begin filling with the passed value. If ommited the array will be filled from the first index.
: The first index of the outermost array to begin filling with the passed value. If omitted the array will be filled from the first index.

---

Expand All @@ -62,7 +62,7 @@ Type
: BetterArray `Object`

Description
: The current instance of the BetterArray object array filled with the passed value between the specified indices. If ommited the array will be filled to the last index.
: The current instance of the BetterArray object array filled with the passed value between the specified indices. If omitted the array will be filled to the last index.

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/api/methods/Filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Necessity
: Optional

Description
: Boolean value indicating whether the filter should be applied recrsively to a jagged or multidimensional array. By default, only the outermost array will be filtered.
: Boolean value indicating whether the filter should be applied recursively to a jagged or multidimensional array. By default, only the outermost array will be filtered.

### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/api/methods/FilterType.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Necessity
: Optional

Description
: Boolean value indicating whether the filter should be applied recrsively to a jagged or multidimensional array. By default, only the outermost array will be filtered.
: Boolean value indicating whether the filter should be applied recursively to a jagged or multidimensional array. By default, only the outermost array will be filtered.

### Returns

Expand Down
7 changes: 1 addition & 6 deletions docs/api/methods/FromCSVFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Necessity
: Optional

Description
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sqeuence.
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sequence.

---

Expand Down Expand Up @@ -133,8 +133,3 @@ End Sub


[Back to Docs](https://senipah.github.io/VBA-Better-Array/)





7 changes: 1 addition & 6 deletions docs/api/methods/FromCSVString.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Necessity
: Optional

Description
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sqeuence.
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sequence.

---

Expand Down Expand Up @@ -116,8 +116,3 @@ Description


[Back to Docs](https://senipah.github.io/VBA-Better-Array/)





2 changes: 1 addition & 1 deletion docs/api/methods/Includes.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Necessity
: Optional

Description
: If the array is jagged (an array of arrays) or multidimensional (which are stored internally as jagged arays) and you wish for all nested arrays to be checked then `recurse` must be true - otherwise only the outermost array will be checked. This argument has no effect when operating on a one-dimension array.
: If the array is jagged (an array of arrays) or multidimensional (which are stored internally as jagged arrays) and you wish for all nested arrays to be checked then `recurse` must be true - otherwise only the outermost array will be checked. This argument has no effect when operating on a one-dimension array.


### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/api/methods/IncludesType.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Necessity
: Optional

Description
: If the array is jagged (an array of arrays) or multidimensional (which are stored internally as jagged arays) and you wish for all nested arrays to be checked then `recurse` must be true - otherwise only the outermost array will be checked. This argument has no effect when operating on a one-dimension array.
: If the array is jagged (an array of arrays) or multidimensional (which are stored internally as jagged arrays) and you wish for all nested arrays to be checked then `recurse` must be true - otherwise only the outermost array will be checked. This argument has no effect when operating on a one-dimension array.


### Returns
Expand Down
2 changes: 1 addition & 1 deletion docs/api/methods/IsSorted.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ grand_parent: API
# IsSorted

## Description
The `IsSorted()` method tests if the stored array is sorted in ascending order. If a `ColumnIndex` argument is provided and the array is jagged or multi-dimensional, it will test if the aray is sorted by the values in that column.
The `IsSorted()` method tests if the stored array is sorted in ascending order. If a `ColumnIndex` argument is provided and the array is jagged or multi-dimensional, it will test if the array is sorted by the values in that column.

#### Note

Expand Down
4 changes: 2 additions & 2 deletions docs/api/methods/Max.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ grand_parent: API
# Max

## Description
The `Max()` method returns the largest value in a list of values. If no argments are passed the `Max()` method will use the stored array. Returns `Empty` if array is uninitialized, or only contains non-scalar variables. If operating on a jagged or multi-dimensional array, the value returned will be the largest value in all of the arrays combined.
The `Max()` method returns the largest value in a list of values. If no arguments are passed the `Max()` method will use the stored array. Returns `Empty` if array is uninitialized, or only contains non-scalar variables. If operating on a jagged or multi-dimensional array, the value returned will be the largest value in all of the arrays combined.

#### Note
Multi-dimensional arrays assigned to the `.Items` property are converted to jagged arrays internally and will be treated as such by the `Max()` method.
Expand All @@ -25,7 +25,7 @@ Type
: ParamArray `Variant`

Necessity
: Opional
: Optional

Description
: A list of values or an array to compare. If no arguments are provided the `Max()` method will return the largest value on the stored array.
Expand Down
5 changes: 2 additions & 3 deletions docs/api/methods/Min.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ grand_parent: API
# Min

## Description
The `Min()` method returns the smallest value in a list of values. If no argments are passed the `Min()` method will use the stored array. Returns `Empty` if array is uninitialized, or only contains non-scalar variables. If operating on a jagged or multi-dimensional array, the value returned will be the smallest value in all of the arrays combined.
The `Min()` method returns the smallest value in a list of values. If no arguments are passed the `Min()` method will use the stored array. Returns `Empty` if array is uninitialized, or only contains non-scalar variables. If operating on a jagged or multi-dimensional array, the value returned will be the smallest value in all of the arrays combined.

#### Note
Multi-dimensional arrays assigned to the `.Items` property are converted to jagged arrays internally and will be treated as such by the `Min()` method.
Expand All @@ -26,7 +26,7 @@ Type
: ParamArray `Variant`

Necessity
: Opional
: Optional

Description
: A list of values or an array to compare. If no arguments are provided the `Min()` method will return the smallest value on the stored array.
Expand Down Expand Up @@ -61,4 +61,3 @@ End Sub


[Back to Docs](https://senipah.github.io/VBA-Better-Array/)

4 changes: 2 additions & 2 deletions docs/api/methods/ParseFromString.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Necessity
: Optional

Description
: If provided, the string passed to `ArrayOpenDelimiter` will be used to mark the beginning of arrays. If ommitted, the default character of `{` will be used.
: If provided, the string passed to `ArrayOpenDelimiter` will be used to mark the beginning of arrays. If omitted, the default character of `{` will be used.

---

Expand All @@ -67,7 +67,7 @@ Necessity
: Optional

Description
: If provided, the string passed to `ArrayClosingDelimiter` will be used to mark the beginning of arrays. If ommitted, the default character of `}` will be used.
: If provided, the string passed to `ArrayClosingDelimiter` will be used to mark the beginning of arrays. If omitted, the default character of `}` will be used.


### Returns
Expand Down
8 changes: 4 additions & 4 deletions docs/api/methods/Shuffle.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ grand_parent: API
# Shuffle

## Description
The `Shuffle()` method Shuffles the order of elements in the array using the [Fisher–Yates algorithm](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#The_modern_algorithm) .
The `Shuffle()` method Shuffles the order of elements in the array using the [Fisher–Yates algorithm](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#The_modern_algorithm).

## Syntax

*expression*.**Shuffle**([*recurse*])

### Parameters

Name
Name
: `recurse`

Type
Expand Down Expand Up @@ -43,7 +43,7 @@ Public Sub ShiftExample()
Dim result() As Variant
Dim MyArray As BetterArray
Set MyArray = New BetterArray

MyArray.Push "Banana", "Orange", "Apple", "Mango"
MyArray.Shuffle
result = MyArray.Items
Expand All @@ -53,4 +53,4 @@ Public Sub ShiftExample()
End Sub
```

[Back to Docs](https://senipah.github.io/VBA-Better-Array/)
[Back to Docs](https://senipah.github.io/VBA-Better-Array/)
2 changes: 1 addition & 1 deletion docs/api/methods/Splice.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `Splice()` method changes the contents of an array by removing or replacing

## Syntax

*expression*.**Splice**(*StartIndex*, [*DeleteCount*,[*Item1*[, *Item2*[, ...[, *ItemN*]]]])
*expression*.**Splice**(*StartIndex*, [*DeleteCount*,[*Item1*[, *Item2*[, ...[, *ItemN*]]]]])

### Parameters

Expand Down
11 changes: 3 additions & 8 deletions docs/api/methods/ToCSVFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Necessity
: Optional

Description
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sqeuence.
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sequence.

---

Expand Down Expand Up @@ -113,7 +113,7 @@ Necessity
: Optional

Description
: If provided, all date values will be formmatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.
: If provided, all date values will be formatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.

---

Expand All @@ -127,7 +127,7 @@ Necessity
: Optional

Description
: If provided, all numeric values will be formmatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.
: If provided, all numeric values will be formatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.



Expand All @@ -143,8 +143,3 @@ Description


[Back to Docs](https://senipah.github.io/VBA-Better-Array/)





11 changes: 3 additions & 8 deletions docs/api/methods/ToCSVString.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Necessity
: Optional

Description
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sqeuence.
: The character(s) used to escape characters within cells of the CSV file. If omitted, the character `"` (double quote) is used indicate the opening and closing of an escape sequence.

---

Expand Down Expand Up @@ -96,7 +96,7 @@ Necessity
: Optional

Description
: If provided, all date values will be formmatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.
: If provided, all date values will be formatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.

---

Expand All @@ -110,7 +110,7 @@ Necessity
: Optional

Description
: If provided, all numeric values will be formmatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.
: If provided, all numeric values will be formatted using the value in this argument forwarded to the VBA [Format()](https://docs.microsoft.com/en-us/office/vba/language/reference/user-interface-help/format-function-visual-basic-for-applications) function.



Expand All @@ -126,8 +126,3 @@ Description


[Back to Docs](https://senipah.github.io/VBA-Better-Array/)





7 changes: 1 addition & 6 deletions docs/api/methods/ToExcelRange.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Necessity
: Required

Description
: An Excel Range object representing the loction to begin writing the stored values. Will be expanded as necessar to accomodate the size of the array.
: An Excel Range object representing the location to begin writing the stored values. Will be expanded as necessary to accommodate the size of the array.

---

Expand Down Expand Up @@ -68,8 +68,3 @@ End Sub
```

[Back to Docs](https://senipah.github.io/VBA-Better-Array/)





6 changes: 3 additions & 3 deletions docs/api/methods/ToString.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ 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.
: If provided, the string passed to `separator` will be used to separate individual elements within the array. If omitted, the default character of `,` will be used.

---

Expand All @@ -53,7 +53,7 @@ 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.
: If provided, the string passed to `OpeningDelimiter` will be used to mark the beginning of arrays. If omitted, the default character of `{` will be used.

---

Expand All @@ -67,7 +67,7 @@ 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.
: If provided, the string passed to `ClosingDelimiter` will be used to mark the beginning of arrays. If omitted, the default character of `}` will be used.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/methods/Unique.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Necessity
: Optional

Description
: A base-1 index of the column in a jagged or multi-dimension array with 2 dimensions to filter by unique values. If no column index is provided and the array is jagged then Unique will compare all elements in nested arrays for equality when determining which nested arrays are Unique. If the `ColumnIndex` is greater than the max length of the arrays at the second dimenson the first column at that dimension will be used.
: A base-1 index of the column in a jagged or multi-dimension array with 2 dimensions to filter by unique values. If no column index is provided and the array is jagged then Unique will compare all elements in nested arrays for equality when determining which nested arrays are Unique. If the `ColumnIndex` is greater than the max length of the arrays at the second dimension the first column at that dimension will be used.

### Returns

Expand Down
8 changes: 4 additions & 4 deletions docs/api/properties/item/item_setter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 2
# Item Let Accessor

## Description
Replaces the array item at the specified index with the passed element. If the `Index` argument exceeds the current upper bound of the stored array, the element will be pushed onto the end of the array at the next available index (this changes the length and upper bound of the stored array). If the index argument is less than the LowerBound (base index) of the stored array the element will be inserted at the beginning of the array and the existing elements shifted up to accomodate the new element (this changes the length and upper bound of the stored array).
Replaces the array item at the specified index with the passed element. If the `Index` argument exceeds the current upper bound of the stored array, the element will be pushed onto the end of the array at the next available index (this changes the length and upper bound of the stored array). If the index argument is less than the LowerBound (base index) of the stored array the element will be inserted at the beginning of the array and the existing elements shifted up to accommodate the new element (this changes the length and upper bound of the stored array).

## Syntax

Expand All @@ -21,7 +21,7 @@ Or

### Parameters

Name
Name
: `Index`

Type
Expand All @@ -35,7 +35,7 @@ Description

---

Name
Name
: `Element`

Type
Expand All @@ -51,4 +51,4 @@ Description

**None**

[Back to Item overview](https://senipah.github.io/VBA-Better-Array/api/properties/item/Item)
[Back to Item overview](https://senipah.github.io/VBA-Better-Array/api/properties/item/Item)
4 changes: 2 additions & 2 deletions docs/home/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ End Sub

## Accessing elements in the array

To access individual elements stored in the array, use the [Item](https://senipah.github.io/VBA-Better-Array/api/properties/item/Item.html) property. As Item is the default member of the better array class, it can be accessed explicilty or implicitly.
To access individual elements stored in the array, use the [Item](https://senipah.github.io/VBA-Better-Array/api/properties/item/Item.html) property. As Item is the default member of the better array class, it can be accessed explicitly or implicitly.

### Retrieving elements

Expand Down Expand Up @@ -223,4 +223,4 @@ End Sub

#### NOTE

Multi-dimension arrays are converted to jagged arrays on assignment and converted back to a multi-dimension (tabular) structur on retrieval.
Multi-dimension arrays are converted to jagged arrays on assignment and converted back to a multi-dimension (tabular) structure on retrieval.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Home
has_children: true
has_children: true
nav_order: 1
---

# VBA Better Array Documentation

VBA Better Array provides a cross-platform array class with a focus on developer convenience.
VBA Better Array provides a cross-platform array class with a focus on developer convenience.

Working with arrays in VBA can be a pain. While accessing native arrays is fast in VBA, adding new entries to the end of an exising array essentially means copying the whole array into a new array and requires multiple statements to do so. In addition, VBA arrays don't come with many of the built-in methods found in more modern languages, such as the ability to easily sort, slice and join to other arrays.
Working with arrays in VBA can be a pain. While accessing native arrays is fast in VBA, adding new entries to the end of an existing array essentially means copying the whole array into a new array and requires multiple statements to do so. In addition, VBA arrays don't come with many of the built-in methods found in more modern languages, such as the ability to easily sort, slice and join to other arrays.

This project aims to help bridge that gap, making working with arrays in VBA both simpler and more convenient.

Expand Down
Loading