PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Inserting an element into an array
  • Adding an element into an advanced array property
  • Inserting an element into a list
  • Inserting a table
  • Inserting a list
  • Use conditions
  • Miscellaneous
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Inserts an element at a given position:
  • into a one-dimensional array.
  • into an associative array.
  • into an advanced array property (array of gglCalendar events, etc.).
  • into a WLanguage list.
This function can also be used to concatenate two arrays or two lists.
WEBDEV - Browser codePHP Remark: This function can only be used with Array and Associative Array variables.
Versions 15 and later
Android This function is now available for Android applications.
New in version 15
Android This function is now available for Android applications.
Android This function is now available for Android applications.
Versions 16 and later
Universal Windows 10 App This function is now available for Windows Phone applications.
New in version 16
Universal Windows 10 App This function is now available for Windows Phone applications.
Universal Windows 10 App This function is now available for Windows Phone applications.
Versions 17 and later
iPhone/iPad This function is now available for iPhone/iPad applications.
WEBDEV - Browser code This function is now available in browser code.
New in version 17
iPhone/iPad This function is now available for iPhone/iPad applications.
WEBDEV - Browser code This function is now available in browser code.
iPhone/iPad This function is now available for iPhone/iPad applications.
WEBDEV - Browser code This function is now available in browser code.
Versions 18 and later
Android Widget This function is now available in Android widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Android Widget This function is now available in Android widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Apple Watch This function is now available in Apple Watch mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Apple Watch This function is now available in Apple Watch mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Apple Watch This function is now available in Apple Watch mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
MyArray is array of 2 strings
MyArray.Insert(1, "WINDEV")
MyArray.Insert(2, "WEBDEV")
MyArray.Insert(3, "WINDEV and WEBDEV")
// Display the content of 3rd element
Trace(MyArray[3]) // Displays "WINDEV and WEBDEV"
MyArray is array of 2 strings
MyArray[1] = "WINDEV"
MyArray[2] = "WEBDEV"
MyArray.Insert(3, "WINDEV and WEBDEV")
// Display the content of 3rd element
Trace(MyArray[3]) // Displays "WINDEV and WEBDEV"
// Associative array Last Name - First Name
aaLastNameFirstName is associative array of strings
aaLastNameFirstName.Insert("Smith", "Tommy")
aaLastNameFirstName.Insert("Montgomery", "Julia")
Syntax

Inserting an element into an array or into an advanced array property Hide the details

<WLanguage array>.Insert(<Insertion index> [, <Element value>])
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array.
<Insertion index>: Integer
Index where the element will be inserted into the array. From this index, all elements will be moved by 1 element.
If <Insertion index> is equal to the number of array elements +1, the element is added at the end of the array (equivalent to <Array>.Add).
A WLanguage error occurs if <Insertion index> is greater than the number of elements in the array +1.
<Element value>: Any type, optional
Element that will be inserted into the specified array, at the given position. If this parameter is not specified, the array is enlarged with the default value of the type of the other array elements.

Inserting an element into an associative array Hide the details

<WLanguage array>.Insert(<Element key> , <Element value>)
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array.
<Element key>: Type of key in the associative array
Value of key for which the element will be inserted. In an associative array without duplicate, a WLanguage error occurs if the element already exists.
<Element value>: Any type
Element that must be added to the specified array.

Inserting an array into an array Hide the details

<WLanguage array>.Insert(<Insertion index> [, <Array to insert>])
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array.
<Insertion index>: Integer
Index where the element will be inserted into the array. From this index, all elements will be moved by 1 element.
If <Insertion index> is equal to the number of array elements +1, the element is added at the end of the array (equivalent to <Array>.Add).
A WLanguage error occurs if <Insertion index> is greater than the number of elements in the array +1.
<Array to insert>: Optional array
Name of the Array variable to insert at the insertion index specified in <WLanguage array>.
WEBDEV - Browser codePHP Not available in browser code and in PHP

Inserting an element into a list Hide the details

<WLanguage list>.Insert(<Insertion index> , <Element value>)
<WLanguage list>: List
Name of List variable to use.
<Insertion index>: Integer constant
Index where the element will be inserted into the list. The following constants can be used:
FirstElementThe element is inserted at the beginning of list.
LastElementThe element is inserted at the end of list.
BeforeCurrentElementThe element is inserted before the current element.
This constant is available when browsing the list elements only.
Caution: The element will be browsed by the next iteration if the loop is a descending loop.
AfterCurrentElementThe element is inserted after the current element.
This constant is available when browsing the list elements only.
Caution: The element will be browsed by the next iteration if the loop is an ascending loop.
<Element value>: Any type
Element that will be inserted into the list at the specified position.
WEBDEV - Browser codePHP Not available in browser code and in PHP

Inserting a list into a list Hide the details

<WLanguage list>.Insert(<Insertion index> , <List to be inserted>)
<WLanguage list>: List
Name of List variable to use.
<Insertion index>: Integer constant
Index where the list will be inserted into the list. The following constants can be used:
FirstElementThe list is inserted at the beginning of <List name>.
LastElementThe list is inserted at the end of <List name>.
BeforeCurrentElementThe list is inserted before the current element.
This constant is available when browsing the list elements only.
AfterCurrentElementThe list is inserted after the current element.
This constant is available when browsing the list elements only.

<List to be inserted>: List
Name of the list that will be inserted at the specified insertion index.
Remarks

Inserting an element into an array

When <Array>.Insert is called:
  • the array is automatically enlarged to receive the new element.
  • the element is converted (if necessary) into the type of the other array elements.
When declaring an array of N elements, this array contains N empty elements. For example, the array declared below contains 3 empty strings.
MonTableau is array of 3 strings
When inserting an element (<Array>.Insert), this element is automatically inserted among the elements already found in the array.
In our example, the array will contain 4 elements once the insertion is performed.

Adding an element into an advanced array property

When <Array>.Insert is called:
  • the advanced variable must be created.
  • the advanced type must have an enumerator of modifiable collection type.
  • the advanced type is automatically enlarged to receive the new elements.
  • the element is initialized with the value passed as parameter. If no value is passed in parameter, the element is initialized with the default value of the type of the array elements.

Inserting an element into a list

When <Array>.Insert is called:
  • the list is automatically enlarged to receive the new element.
  • the element is converted (if necessary) into the type of the other list elements.
WEBDEV - Browser codePHP This feature is not available.

Inserting a table

When <Array>.Insert is called:
  • the array is automatically resized to receive the new elements. The elements of <Name of array to insert> are added at the position specified in <Array name>.
  • the two arrays must have the same type.
  • the arrays must have the same dimension.
  • the values of array dimensions (except for the first one) must be identical.

Inserting a list

When <Array>.Insert is called:
  • the list is automatically enlarged to receive the new elements. The elements of <Name of list to insert> are added at the specified position.
  • the two lists must have the same type.
WEBDEV - Browser codePHP This feature is not available.

Use conditions

This function can be used with the structures. In this case, you must:
  1. Declare a variable (same type as the structure).
  2. Initialize each member.
  3. Pass the structure variable in parameter to <Array>.Insert.
This function cannot be used on:
  • non-created arrays
  • fixed arrays.

Miscellaneous

  • To add an element at the end of a one-dimensional array, use <Array>.Add.
  • To add an element into a sorted array (while respecting the sort), use <Array>.AddSorted.
Component: wd270vm.dll
Minimum version required
  • Version 23
This page is also available for…
Comments
Click [Add] to post a comment