# GuiListView user defined functions Reference

Below is a complete list of the user defined functions available in AutoIt. Click on a user defined function name for a detailed description.

When using them you need to add a #include <GuiListView.au3>.

User Defined Function | Description
--- | ---
_GUICtrlListView_AddArray | Adds items from an array to the control
_GUICtrlListView_AddColumn | Adds a new column in the control
_GUICtrlListView_AddItem | Adds a new item to the end of the list
_GUICtrlListView_AddSubItem | Adds a new subitem to the control
_GUICtrlListView_ApproximateViewHeight | Calculates the approximate height required to display a given number of items
_GUICtrlListView_ApproximateViewRect | Calculates the approximate size required to display a given number of items
_GUICtrlListView_ApproximateViewWidth | Calculates the approximate width required to display a given number of items
_GUICtrlListView_Arrange | Arranges items in icon view
_GUICtrlListView_BeginUpdate | Prevents updating of the control until the _GUICtrlListView_EndUpdate() function is called
_GUICtrlListView_CancelEditLabel | Cancels an item text editing operation
_GUICtrlListView_ClickItem | Clicks an item
_GUICtrlListView_CopyItems | Copy Items between 2 list-view controls
_GUICtrlListView_Create | Create a ListView control
_GUICtrlListView_CreateDragImage | Creates a drag image list for the specified item
_GUICtrlListView_CreateSolidBitMap | Creates a solid color bitmap
_GUICtrlListView_DeleteAllItems | Removes all items from a list-view control
_GUICtrlListView_DeleteColumn | Removes a column from a list-view control
_GUICtrlListView_DeleteItem | Removes an item from a list-view control
_GUICtrlListView_DeleteItemsSelected | Deletes item(s) selected
_GUICtrlListView_Destroy | Delete the listview control
_GUICtrlListView_DrawDragImage | Draw the Drag Image
_GUICtrlListView_EditLabel | Begins in place editing of the specified item text
_GUICtrlListView_EnableGroupView | Enables or disables whether the items in the control display as a group
_GUICtrlListView_EndUpdate | Enables screen repainting that was turned off with the _GUICtrlListView_BeginUpdate() function
_GUICtrlListView_EnsureVisible | Ensures that a list-view item is either entirely or partially visible
_GUICtrlListView_FindInText | Searches for an item that contains the specified text anywhere in its text
_GUICtrlListView_FindItem | Searches for an item with the specified characteristics
_GUICtrlListView_FindNearest | Finds the item nearest to the position specified
_GUICtrlListView_FindParam | Searches for an item with the specified lParam
_GUICtrlListView_FindText | Searches for an item with the specified text
_GUICtrlListView_GetBkColor | Retrieves the background color of a list-view control
_GUICtrlListView_GetBkImage | Retrieves the background image in the control
_GUICtrlListView_GetCallbackMask | Retrieves the callback mask for the control
_GUICtrlListView_GetColumn | Retrieves the attributes of a column
_GUICtrlListView_GetColumnCount | Retrieve the number of columns
_GUICtrlListView_GetColumnOrder | Retrieves the current left-to-right order of columns
_GUICtrlListView_GetColumnOrderArray | Retrieves the current left-to-right order of columns in the control
_GUICtrlListView_GetColumnWidth | Retrieves the width of a column in report or list view
_GUICtrlListView_GetCounterPage | Calculates the number of items that can fit vertically in the visible area
_GUICtrlListView_GetEditControl | Retrieves the handle to the edit control being used to edit an item's text
_GUICtrlListView_GetExtendedListViewStyle | Retrieves the extended styles that are currently in use
_GUICtrlListView_GetFocusedGroup | Gets the group that has the focus
_GUICtrlListView_GetGroupCount | Gets the number of groups
_GUICtrlListView_GetGroupInfo | Retrieves group information
_GUICtrlListView_GetGroupInfoByIndex | Retrieves group information
_GUICtrlListView_GetGroupRect | Gets the rectangle for a specified group
_GUICtrlListView_GetGroupViewEnabled | Checks whether the control has group view enabled
_GUICtrlListView_GetHeader | Retrieves the handle to the header control
_GUICtrlListView_GetHotCursor | Retrieves the HCURSOR value used when the pointer is over an item while hot tracking is enabled
_GUICtrlListView_GetHotItem | Retrieves the index of the hot item
_GUICtrlListView_GetHoverTime | Retrieves the amount of time that the mouse cursor must hover over an item before it is selected
_GUICtrlListView_GetImageList | Retrieves the handle to an image list used for drawing listview items
_GUICtrlListView_GetISearchString | Retrieves the incremental search string of the control
_GUICtrlListView_GetItem | Retrieves an item's attributes
_GUICtrlListView_GetItemChecked | Returns the check state for a list-view control item
_GUICtrlListView_GetItemCount | Retrieves the number of items in a list-view control
_GUICtrlListView_GetItemCut | Determines whether the item is marked for a cut and paste operation
_GUICtrlListView_GetItemDropHilited | Determines whether the item is highlighted as a drag-and-drop target
_GUICtrlListView_GetItemEx | Retrieves some or all of an item's attributes
_GUICtrlListView_GetItemFocused | Determines whether the item is highlighted as a drag-and-drop target
_GUICtrlListView_GetItemGroupID | Gets the item group ID
_GUICtrlListView_GetItemImage | Retrieves the index of the item's icon
_GUICtrlListView_GetItemIndent | Retrieves the number of image widths the item is indented
_GUICtrlListView_GetItemParam | Retrieves the application specific value of the item
_GUICtrlListView_GetItemPosition | Retrieves the position of an item
_GUICtrlListView_GetItemPositionX | Retrieves the X position of an item
_GUICtrlListView_GetItemPositionY | Retrieves the Y position of an item
_GUICtrlListView_GetItemRect | Retrieves the bounding rectangle for all or part of an item
_GUICtrlListView_GetItemRectEx | Retrieves the bounding rectangle for all or part of an item
_GUICtrlListView_GetItemSelected | Determines whether the item is selected
_GUICtrlListView_GetItemSpacing | Determines the spacing between items in the control
_GUICtrlListView_GetItemSpacingX | Determines the horizontal spacing between items in the control
_GUICtrlListView_GetItemSpacingY | Determines the vertical spacing between items in the control
_GUICtrlListView_GetItemState | Retrieves the state of a listview item
_GUICtrlListView_GetItemStateImage | Gets the state image that is displayed
_GUICtrlListView_GetItemText | Retrieves the text of an item or subitem
_GUICtrlListView_GetItemTextArray | Retrieves all of a list-view item
_GUICtrlListView_GetItemTextString | Retrieves all of a list-view item
_GUICtrlListView_GetNextItem | Searches for an item that has the specified properties
_GUICtrlListView_GetNumberOfWorkAreas | Retrieves the number of working areas in the control
_GUICtrlListView_GetOrigin | Retrieves the current view origin for the control
_GUICtrlListView_GetOriginX | Retrieves the current horizontal view origin for the control
_GUICtrlListView_GetOriginY | Retrieves the current vertical view origin for the control
_GUICtrlListView_GetOutlineColor | Retrieves the color of the border of the control
_GUICtrlListView_GetSelectedColumn | Retrieves the index of the selected column
_GUICtrlListView_GetSelectedCount | Determines the number of selected items
_GUICtrlListView_GetSelectedIndices | Retrieve indices of selected item(s)
_GUICtrlListView_GetSelectionMark | Retrieves the selection mark from the control
_GUICtrlListView_GetStringWidth | Determines the width of a specified string
_GUICtrlListView_GetSubItemRect | Retrieves information about an item bounding rectangle
_GUICtrlListView_GetTextBkColor | Retrieves the text background color of the control
_GUICtrlListView_GetTextColor | Retrieves the text color of the control
_GUICtrlListView_GetToolTips | Retrieves the ToolTip control handle
_GUICtrlListView_GetTopIndex | Retrieves the index of the topmost visible item when in list or report view
_GUICtrlListView_GetUnicodeFormat | Retrieves the Unicode character format flag for the control
_GUICtrlListView_GetView | Retrieves the current view of the control
_GUICtrlListView_GetViewDetails | Determines whether the view mode is in detail mode
_GUICtrlListView_GetViewLarge | Determines whether the view mode is in large icon mode
_GUICtrlListView_GetViewList | Determines whether the view mode is in list mode
_GUICtrlListView_GetViewRect | Retrieves the bounding rectangle of all items in the control
_GUICtrlListView_GetViewSmall | Determines whether the view mode is in small icon mode
_GUICtrlListView_GetViewTile | Determines whether the view mode is in tile mode
_GUICtrlListView_HideColumn | Hides the column "sets column width to zero"
_GUICtrlListView_HitTest | Determines which item is at a specified position
_GUICtrlListView_InsertColumn | Inserts a new column in the control
_GUICtrlListView_InsertGroup | Inserts a group
_GUICtrlListView_InsertItem | Inserts a new item in the control
_GUICtrlListView_JustifyColumn | Set Justification of a column for a list-view control
_GUICtrlListView_MapIDToIndex | Maps the ID of an item to an index
_GUICtrlListView_MapIndexToID | Maps an index to an item ID
_GUICtrlListView_RedrawItems | Forces the control to redraw a range of items
_GUICtrlListView_RegisterSortCallBack | Register the Simple Sort callback function
_GUICtrlListView_RemoveAllGroups | Removes all groups from the control
_GUICtrlListView_RemoveGroup | Removes a group from the control
_GUICtrlListView_Scroll | Scrolls the content of a list-view
_GUICtrlListView_SetBkColor | Sets the background color of the control
_GUICtrlListView_SetBkHBITMAP | Set in the ListView a background image based on the Bitmap handle
_GUICtrlListView_SetBkImage | Sets the background image in the control
_GUICtrlListView_SetCallBackMask | Changes the callback mask for the control
_GUICtrlListView_SetColumn | Sets the attributes of a column
_GUICtrlListView_SetColumnOrder | Sets the left-to-right order of columns
_GUICtrlListView_SetColumnOrderArray | Sets the left-to-right order of columns in the control
_GUICtrlListView_SetColumnWidth | Changes the width of a column
_GUICtrlListView_SetExtendedListViewStyle | Sets extended styles
_GUICtrlListView_SetGroupInfo | Sets group information
_GUICtrlListView_SetHotItem | Sets the hot item
_GUICtrlListView_SetHoverTime | Sets the amount of time which the mouse cursor must hover over an item before it is selected
_GUICtrlListView_SetIconSpacing | Sets the spacing between icons where the style is large icon
_GUICtrlListView_SetImageList | Assigns an image list to the control
_GUICtrlListView_SetItem | Sets some or all of a item's attributes
_GUICtrlListView_SetItemChecked | Sets the checked state
_GUICtrlListView_SetItemCount | Causes the list-view control to allocate memory for the specified number of items
_GUICtrlListView_SetItemCut | Sets whether the item is marked for a cut-and-paste operation
_GUICtrlListView_SetItemDropHilited | Sets whether the item is highlighted as a drag-and-drop target
_GUICtrlListView_SetItemEx | Sets some or all of a item's attributes
_GUICtrlListView_SetItemFocused | Sets whether the item has the focus
_GUICtrlListView_SetItemGroupID | Sets the item group ID
_GUICtrlListView_SetItemImage | Sets the index of the item's icon in the control's image list
_GUICtrlListView_SetItemIndent | Sets the number of image widths to indent the item
_GUICtrlListView_SetItemParam | Sets the value specific to the item
_GUICtrlListView_SetItemPosition | Moves an item to a specified position in the control
_GUICtrlListView_SetItemPosition32 | Moves an item to a specified position in the control
_GUICtrlListView_SetItemSelected | Sets whether the item is selected
_GUICtrlListView_SetItemState | Changes the state of an item in the control
_GUICtrlListView_SetItemStateImage | Sets the state image that is displayed
_GUICtrlListView_SetItemText | Changes the text of an item or subitem
_GUICtrlListView_SetOutlineColor | Sets the color of the border
_GUICtrlListView_SetSelectedColumn | Sets the index of the selected column
_GUICtrlListView_SetSelectionMark | Sets the selection mark in the control
_GUICtrlListView_SetTextBkColor | Sets the background color of text in the control
_GUICtrlListView_SetTextColor | Sets the color of text in the control
_GUICtrlListView_SetToolTips | Sets the ToolTip control that the control will use to display ToolTips
_GUICtrlListView_SetUnicodeFormat | Sets the UNICODE character format flag for the control
_GUICtrlListView_SetView | Sets the view of the control
_GUICtrlListView_SetWorkAreas | Creates a work area within the control
_GUICtrlListView_SimpleSort | Sorts a list-view control (limited)
_GUICtrlListView_SortItems | Starts the sort call back, also sets the Arrow in the Header
_GUICtrlListView_SubItemHitTest | Determines which listview item or subitem is at a given position
_GUICtrlListView_UnRegisterSortCallBack | UnRegister the Sort callback function