<List Box>.MoveLine (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Operating mode on a Combo Box control
Multiselection List Box control
Managing errors

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<List Box>.MoveLine (Function)

In french: <Liste>.DéplaceLigne

Moves a row or swaps two rows in a List Box or Combo Box control.

Notes:

To move a row in a Table control, use TableMoveLine.
To move a row in a Looper control, use LooperMoveLine.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Example

// Swap the current row and row 5
LIST_List1.MoveLine(rowSelected, 5, amSwap)
// Move the current row to row 3
LIST_List1.MoveLine(rowSelected, 3, amMove)
// Swap the current row with the next row
LIST_List1.MoveLine(rowSelected, 5, amNext, amSwap)

Syntax

Moving to a specific position Hide the details

<Result> = <List Box control>.MoveLine(<Subscript of row to move> , <Subscript of destination row> [, <Operation to perform>])

<Result>: Integer

New subscript of row that was moved.

<List Box control>: Control name

Name of List Box or Combo Box control to use.

<Subscript of row to move>: Integer

Position of row to move. This position must be included between 1 and the number of rows found in the List Box or Combo Box control (returned by <List Box>.Count or ..Count for example).
To move the row that is currently selected, use the rowSelected constant.

<Subscript of destination row>: Integer

New row position. This position must be included between 1 and the number of rows found in the List Box or Combo Box control (returned by <List Box>.Count or ..Count for example). A fatal error occurs if this parameter is not valid.
To handle the row that is currently selected, use the rowSelected constant.

<Operation to perform>: Optional Integer constant (or combination of constants)

Change of position that will be performed for the row:
amDisplayDestination The modified row is displayed in the List Box control (or Combo Box). An automatic scroll of the rows is performed if necessary to display the modified row. The selected row (selection bar) is not modified.
This constant can be combined with the amMove and amSwap constants.
This constant is not available.
amMove
(default value) The row is moved toward the subscript of destination row.
amSwap The source and destination rows are swapped.

Moving relatively to the current position Hide the details

<Result> = <List Box control>.MoveLine(<Subscript of row to move> , <Relative move> [, <Operation to perform>])

<Result>: Integer

New subscript of row that was moved,
0 if an error occurred.

<List Box control>: Control name

Name of List Box control to use.

<Subscript of row to move>: Integer

Position of row to move. This position must be included between 1 and the number of rows in the List Box control (returned by <List Box>.Count or ..Count for example).
To handle the row that is currently selected, use the rowSelected constant.

<Relative move>: Integer constant

Used to perform a move or a swap on a position relative to the subscript of row to move.
amLast Moves the row to last position.
amPreviousPage Moves the row one page to the top (a page corresponds to the number of rows that can be simultaneously displayed in the List Box control).
This constant is not available.
amNextPage Moves the row one page to the bottom (a page corresponds to the number of rows that can be simultaneously displayed in the List Box control).
This constant is not available.
amPrevious Moves the row one position upwards
amFirst Moves the row to first position.
amNext Moves the row one position downwards.

If this parameter is invalid (amPrevious used on the first row of List Box control for example), the row is moved "to the nearest" position.

<Operation to perform>: Optional Integer constant (or combination of constants)

Change of position that will be performed for the row:
amDisplayDestination The modified row is displayed in the List Box control. An automatic scroll of the rows is performed if necessary to display the modified row. The selected row (selection bar) is not modified.
This constant can be combined with the amMove and amSwap constants.
This constant is not available.
amMove
(default value) The row is moved toward the subscript of destination row.
amSwap The source and destination rows are swapped.

Remarks

Operating mode on a Combo Box control

When <List Box>.MoveLine is used on a Combo Box control, the selected element remains the same. The subscript of the element selected in the drop-down list (i.e. the value returned by the Combo Box control) is modified.

Multiselection List Box control

If <List Box>.MoveLine is used on a multiselection List Box control:

when moving rows (amMove constant): all selected rows will be moved.
when swapping rows (amSwap constant): only the first row will be swapped
the rowSelected constant cannot be used. Otherwise, a fatal error occurs and no row is moved.

Managing errors

Caution: <List Box>.MoveLine returns no error code. To find out whether an error was generated by this function, use ErrorInfo associated with the errMessage constant.

Component : wd240obj.dll