|
|
|
|
|
|
|
|
|
|
- Adding a row into an array
- Adding a row to an advanced array property
- Miscellaneous
AddLine (Function) In french: AjouteLigne Adds a row at the end: - of a one- or two-dimensional WLanguage array.
- of a two-dimensional array property of a variable type (xlsDocument variable for example).
MyArray is array of 2 by 3 strings
AddLine(MyArray, "A", "B", "C")
AddLine(MyArray, "a", "b", "c")
AddLine(MyArray, "D", "E", "F")
// Display the content of the 3rd row (the two first rows are empty)
Trace(MyArray[3,1], MyArray[3,2], MyArray[3,3])
// Displays "A B C"
MyArray is array of 2 by 3 strings
MyArray[1,1] = "A"
MyArray[1,2] = "B"
MyArray[1,3] = "C"
MyArray[2,1] = "a"
MyArray[2,2] = "b"
MyArray[2,3] = "c"
AddLine(MyArray, "D", "E", "F")
// Display the content of the 3rd row
Trace(MyArray[3,1], MyArray[3,2], MyArray[3,3])
// Displays "D E F"
Syntax
<Result> = AddLine(<WLanguage array> [, <Element column 1> [... [, <Element column N>]]])
<Result>: Integer - Index of the added row,
- -1 if an error occurred.
<WLanguage array>: Array Name of the Array variable to use. This array must be a one-dimensional array or a two-dimensional array. <Element column 1>: Type of array elements, optional Element of the row that will be added into the specified array. Each element corresponds to a column in the array. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added to the array. The columns are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding column is initialized with the default value of the type of the other array elements. <Element column N>: Type of array elements, optional Element of the row that will be added into the specified array. Each element corresponds to a column in the array. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added to the array. The columns are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding column is initialized with the default value of the type of the other array elements. Remarks Adding a row into an array When AddLine is called: - the number of rows in the array is automatically increased to include the new row.
- the number of columns in the array is not increased. In this case, choose one of the following options:
- declare the array with the proper number of columns (second dimension of the array).
- dynamically modify the number of columns with Dimension.
- the elements are converted (if necessary) into the type of the other array elements.
Remark: When declaring an array of N by M elements, this array contains N empty rows. For example, the array declared below contains 3 empty rows.MyArray is array of 3 by 2 strings
Rows added using AddLine are automatically added after the existing rows in the array
In our example, the added row corresponds to the 4th row. Adding a row to an advanced array property When AddLine is called: - the array property of the advanced variable must be created.
- the advanced type must have an enumerator of modifiable collection type.
- the advanced array property is automatically enlarged to receive the new row.
Miscellaneous - This function cannot be used on:
- non-created arrays,
- fixed arrays.
- To add a row at a given position, use ArrayInsertLine or Insert.
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|