15 replies to this topic

[guinness]

For those who use ListViews and wish to call a Function to grab the contents of the ListView into a 2D array, then _GUICtrlListView_CreateArray() is for you. It will Return an array with the contents of the ListView inc. the number of rows, columns & column names. Simply run the Example to get an idea of the output. Thanks.

Function:

AutoIt        expandcollapse  popup

; #FUNCTION# ====================================================================================================================
; Name ..........: _GUICtrlListView_CreateArray
; Description ...: Creates a 2-dimensional array from a listview.
; Syntax ........: _GUICtrlListView_CreateArray($hListView[, $sDelimeter = '|'])
; Parameters ....: $hListView           - Control ID/Handle to the control
;                  $sDelimeter          - [optional] One or more characters to use as delimiters (case sensitive). Default is '|'.
; Return values .: Success - The array returned is two-dimensional and is made up of the following:
;                                $aArray[0][0] = Number of rows
;                                $aArray[0][1] = Number of columns
;                                $aArray[0][3] = Delimited string of the column name(s) e.g. Column 1|Column 2|Column 3|Column nth

;                                $aArray[1][0] = 1st row, 1st column
;                                $aArray[1][1] = 1st row, 2nd column
;                                $aArray[1][2] = 1st row, 3rd column
;                                $aArray[n][0] = nth row, 1st column
;                                $aArray[n][1] = nth row, 2nd column
;                                $aArray[n][2] = nth row, 3rd column
; Author ........: guinness
; Remarks .......: GUICtrlListView.au3 should be included.
; Example .......: Yes
; ===============================================================================================================================
Func _GUICtrlListView_CreateArray($hListView, $sDelimeter = '|')
    Local $iColumnCount = _GUICtrlListView_GetColumnCount($hListView), $iDim = 0, $iItemCount = _GUICtrlListView_GetItemCount($hListView)
    If $iColumnCount < 3 Then
        $iDim = 3 - $iColumnCount
    EndIf
    If $sDelimeter = Default Then
        $sDelimeter = '|'
    EndIf

    Local $aColumns = 0, $aReturn[$iItemCount + 1][$iColumnCount + $iDim] = [[$iItemCount, $iColumnCount, '']]
    For $i = 0 To $iColumnCount - 1
        $aColumns = _GUICtrlListView_GetColumn($hListView, $i)
        $aReturn[0][2] &= $aColumns[5] & $sDelimeter
    Next
    $aReturn[0][2] = StringTrimRight($aReturn[0][2], StringLen($sDelimeter))

    For $i = 0 To $iItemCount - 1
        For $j = 0 To $iColumnCount - 1
            $aReturn[$i + 1][$j] = _GUICtrlListView_GetItemText($hListView, $i, $j)
        Next
    Next
    Return SetError(Number($aReturn[0][0] = 0), 0, $aReturn)
EndFunc   ;==>_GUICtrlListView_CreateArray

Example use of Function:

AutoIt        expandcollapse  popup

#include <Array.au3> ; Required only for _ArrayDisplay().
#include <GUIConstantsEx.au3>
#include <GUIListView.au3>
#include <WindowsConstants.au3>

Example()

Func Example()
    Local $iWidth = 600, $iHeight = 400, $iListView = 0
    Local $hGUI = GUICreate('_GUICtrlListView_CreateArray()', $iWidth, $iHeight, -1, -1, BitOR($GUI_SS_DEFAULT_GUI, $WS_MAXIMIZEBOX, $WS_SIZEBOX))

    _CreateListView($hGUI, $iListView)

    Local $iGetArray = GUICtrlCreateButton('Get Array', $iWidth - 90, $iHeight - 28, 85, 25)
    GUICtrlSetResizing(-1, $GUI_DOCKRIGHT + $GUI_DOCKSIZE + $GUI_DOCKBOTTOM)

    Local $iRefresh = GUICtrlCreateButton('Refresh', $iWidth - 180, $iHeight - 28, 85, 25)
    GUICtrlSetResizing(-1, $GUI_DOCKRIGHT + $GUI_DOCKSIZE + $GUI_DOCKBOTTOM)

    GUISetState(@SW_SHOW, $hGUI)

    Local $aReturn = 0, $aStringSplit = 0
    While 1
        Switch GUIGetMsg()
            Case $GUI_EVENT_CLOSE
                ExitLoop

            Case $iGetArray
                $aReturn = _GUICtrlListView_CreateArray($iListView, Default) ; Use | as the default delimeter.
                _ArrayDisplay($aReturn, '_GUICtrlListView_CreateArray() array.')

                $aStringSplit = StringSplit($aReturn[0][2], '|')
                _ArrayDisplay($aStringSplit, 'StringSplit() to retrieve column names.')

            Case $iRefresh
                GUICtrlDelete($iListView)
                _CreateListView($hGUI, $iListView)

        EndSwitch
    WEnd
    GUIDelete($hGUI)
EndFunc   ;==>Example

Func _CreateListView($hGUI, ByRef $iListView) ; Thanks to AZJIO for this function.
    Local $aClientSize = WinGetClientSize($hGUI)
    $iListView = GUICtrlCreateListView('', 0, 0, $aClientSize[0], $aClientSize[1] - 30)
    GUICtrlSetResizing($iListView, $GUI_DOCKBORDERS)
    Sleep(250)

    Local $iColumns = Random(1, 5, 1)
    __ListViewFill($iListView, $iColumns, Random(25, 100, 1)) ; Fill the ListView with Random data.
    For $i = 0 To $iColumns
        _GUICtrlListView_SetColumnWidth($iListView, $i, $LVSCW_AUTOSIZE)
        _GUICtrlListView_SetColumnWidth($iListView, $i, $LVSCW_AUTOSIZE_USEHEADER)
    Next
EndFunc   ;==>_CreateListView

Func __ListViewFill($hListView, $iColumns, $iRows) ; Required only for the Example.
    If Not IsHWnd($hListView) Then
        $hListView = GUICtrlGetHandle($hListView)
    EndIf
    Local $fIsCheckboxesStyle = (BitAND(_GUICtrlListView_GetExtendedListViewStyle($hListView), $LVS_EX_CHECKBOXES) = $LVS_EX_CHECKBOXES)

    _GUICtrlListView_BeginUpdate($hListView)
    For $i = 0 To $iColumns - 1
        _GUICtrlListView_InsertColumn($hListView, $i, 'Column ' & $i + 1, 50)
        _GUICtrlListView_SetColumnWidth($hListView, $i - 1, -2)
    Next
    For $i = 0 To $iRows - 1
        _GUICtrlListView_AddItem($hListView, 'Row ' & $i + 1 & ': Col 1', $i)
        If Random(0, 1, 1) And $fIsCheckboxesStyle Then
            _GUICtrlListView_SetItemChecked($hListView, $i)
        EndIf
        For $j = 1 To $iColumns
            _GUICtrlListView_AddSubItem($hListView, $i, 'Row ' & $i + 1 & ': Col ' & $j + 1, $j)
        Next
    Next
    _GUICtrlListView_EndUpdate($hListView)
EndFunc   ;==>__ListViewFill

Edited by guinness, 20 November 2012 - 09:15 PM.

[Melba23]

guinness,

Nice.

M23

[guinness]

Thank Melba

[spudw2k]

guinness,

I was just looking through you signature (after reading a recent post you replied to) and found this topic. I also made a function to do the same thing. Upon examining and comparing our methods it seems the only real differences are my function doesn't have error checking and I dynamically build the array instead of initial size declaration. Less the error checking, I assume declaring the array size initially has better performance than performing a Ubound over and over. Would you agree?

[guinness]

In your example ReDim is the real issue with performance (look at _ReDim in my signature) so since you know the number of rows anyway it's best just to initial the array at the start of the function. I've also read that the larger the array becomes the slower Ubound is, though we're talking ms. Another point is some variables aren't declared in Local scope and you're declaring a variable inside a loop which can affect performance too.

I wonder what the difference in time is? I will check this evening.

Edited by guinness, 13 November 2011 - 08:22 PM.

[guinness]

With 5000 items the results were:

Mine: 1313.33962550961
Yours: 13802.8888616261

Mine: 1404.9440669193
Yours: 13556.6254318947

But on a ListView with 100 it wasn't worth documenting.

Edited by guinness, 14 November 2011 - 12:36 AM.

[spudw2k]

Cool, thanks for the knowledge and benchmarks.

[guinness]

No problem, thanks for pointing out your function to me. I remember your project SpeeDBurner come to think of it, believe it or not it was something I used when I started out with AutoIt.

[newsman220]

This is fantastic. I'm using ListViews to hold the results of WMI queries, and this is the ideal way to get them out to a spreadsheet. Thanks for giving this to the community!

[guinness]

No problem. Thanks for the compliment.

[JScript]

5 stars from me! Thank you my friend.


JS

[AZJIO]

This can be shorter

$sIndex = _GUICtrlListView_GetItemText($hListView, $A)
$aReturn[$A + 1][0] = $sIndex

5 stars. Useful thing

Edited by AZJIO, 07 February 2013 - 09:17 AM.

[guinness]

I will optimise the function today as i've learnt a lot in the last year.

[guinness]

I've updated the function as promised and optimised the code greatly. Now there are fewer lines and no more unnecessary variables. See the original post for more details.

Edit: Oh, and the times mentioned in post #6 have been decreased by 120%!

Edited by guinness, 08 October 2012 - 10:43 AM.

[AZJIO]

AutoIt        expandcollapse  popup

#include <Array.au3> ; Required only for _ArrayDisplay().
#include <GUIConstantsEx.au3>
#include <GUIListView.au3>
#include <WindowsConstants.au3>
#include <_GUICtrlListView_CreateArray.au3>

Example()

Func Example()
    Local $iWidth = 600, $iHeight = 400, $iListView
    Local $hGUI = GUICreate('_GUICtrlListView_CreateArray()', $iWidth, $iHeight, -1, -1, BitOR($GUI_SS_DEFAULT_GUI, $WS_MAXIMIZEBOX, $WS_SIZEBOX))

    _CreateListView($hGUI, $iListView)

    Local $iGetArray = GUICtrlCreateButton('Get Array', $iWidth - 120, $iHeight - 28, 115, 27)
    GUICtrlSetResizing(-1, $GUI_DOCKRIGHT + $GUI_DOCKSIZE + $GUI_DOCKBOTTOM)

    Local $iRefresh = GUICtrlCreateButton('Refresh', $iWidth - 240, $iHeight - 28, 115, 27)
    GUICtrlSetResizing(-1, $GUI_DOCKRIGHT + $GUI_DOCKSIZE + $GUI_DOCKBOTTOM)

    GUISetState(@SW_SHOW, $hGUI)

    Local $aReturn = 0, $aStringSplit = 0
    While 1
        Switch GUIGetMsg()
            Case $GUI_EVENT_CLOSE
                ExitLoop

            Case $iGetArray
                $aReturn = _GUICtrlListView_CreateArray($iListView, Default) ; Use | as the default delimeter.
                _ArrayDisplay($aReturn, '_GUICtrlListView_CreateArray() array.')

                $aStringSplit = StringSplit($aReturn[0][2], '|')
                _ArrayDisplay($aStringSplit, 'StringSplit() to retrieve column names.')

            Case $iRefresh
                GUICtrlDelete($iListView)
                _CreateListView($hGUI, $iListView)

        EndSwitch
    WEnd
    GUIDelete($hGUI)
EndFunc

Func _CreateListView($hGUI, ByRef $iListView)
    $ClientSize = WinGetClientSize($hGUI)
    $iListView = GUICtrlCreateListView('', 0, 0, $ClientSize[0], $ClientSize[1] - 30)
    GUICtrlSetResizing($iListView, $GUI_DOCKBORDERS)
    Sleep(250)

    $iCol = Random(1, 5, 1)
    __ListViewFill($iListView, $iCol, Random(25, 100, 1)) ; Fill the ListView with Random data.
    For $i = 0 To $iCol
        GUICtrlSendMsg($iListView, $LVM_SETCOLUMNWIDTH, $i, -1)
        GUICtrlSendMsg($iListView, $LVM_SETCOLUMNWIDTH, $i, -2)
    Next
EndFunc

Func __ListViewFill($hListView, $iColumns, $iRows) ; Required only for the Example.
    If Not IsHWnd($hListView) Then
        $hListView = GUICtrlGetHandle($hListView)
    EndIf
    Local $fIsCheckboxesStyle = (BitAND(_GUICtrlListView_GetExtendedListViewStyle($hListView), $LVS_EX_CHECKBOXES) = $LVS_EX_CHECKBOXES)

    _GUICtrlListView_BeginUpdate($hListView)
    For $i = 0 To $iColumns - 1
        _GUICtrlListView_InsertColumn($hListView, $i, 'Column ' & $i + 1, 50)
        _GUICtrlListView_SetColumnWidth($hListView, $i - 1, -2)
    Next
    For $i = 0 To $iRows - 1
        _GUICtrlListView_AddItem($hListView, 'Row ' & $i + 1 & ': Col 1', $i)
        If Random(0, 1, 1) And $fIsCheckboxesStyle Then
            _GUICtrlListView_SetItemChecked($hListView, $i)
        EndIf
        For $j = 1 To $iColumns
            _GUICtrlListView_AddSubItem($hListView, $i, 'Row ' & $i + 1 & ': Col ' & $j + 1, $j)
        Next
    Next
    _GUICtrlListView_EndUpdate($hListView)
EndFunc

Edited by AZJIO, 07 February 2013 - 09:17 AM.

[guinness]

Thanks AZJIO, I updated the example in the first post with your improvement to re-creating the ListView. My version was just a quick 'hack' as I was in a rush to upload the function and example.