---
title: "getListViewItemCheck"
canonical: "https://help.vicon.com/space/ShogunPost121/1253736774/getListViewItemCheck"
format: markdown
---
# Description

Gets the checked state of an item in a list view user control.

## Functional area

User Window

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `getListViewItemCheck userControlID itemRow` |

### Arguments

> Macro (scroll-tablelayout)

| Name | Type | Required | Comments |
| --- | --- | --- | --- |
| `userControlID` | integer | yes | ID of the window to operate on |
| `itemRow` | integer | yes | Row number of the item in the list view |

### Flags

None

## Return value

boolean

Returns the checked state of the item. 

> Macro (scroll-pagebreak)

## Examples

```plaintext
// Demonstrate usage of a List View User Control
int $windowID, $listViewID, $formID;
 
// Destroy window if it already exists
if( `windowExists "ListViewTesting"` == true )
   {
 destroyWindow "ListViewTesting";
   }
// Create window and list view and position them
$windowID = `createWindow "ListViewTesting"`;
$formID = `getTopLevelForm $windowID`;
$listViewID = `createListView $windowID -form $formID -checkBoxes`;

setControlAnchor $listViewID "left" "left" 3;
setControlAnchor $listViewID "top" "top" 3;
setControlAnchor $listViewID "right" "right" 3;
setControlAnchor $listViewID "bottom" "bottom" 3;
 
// Create the columns
string $columns[3];
int $widths[3];
 
$columns[0] = "Name";
$columns[1] = "Age";
$columns[2] = "Gender";
$widths[0] = 150;
$widths[1] = 50;
$widths[2] = 100;
setListViewColumns $listViewID $columns $widths;
 
// Add some items to the list view. The text we supply is for the
// first column. We supply text for subsequent columns using 
// setListViewItemText
addListViewItem $listViewID "Bob";
addListViewItem $listViewID "Mary";
addListViewItem $listViewID "Jim";
addListViewItem $listViewID "Ann";
 
// Set additional details
setListViewItemText $listViewID 0 1 "50";
setListViewItemText $listViewID 0 2 "Male";
setListViewItemText $listViewID 1 1 "32";
setListViewItemText $listViewID 1 2 "Female";
setListViewItemText $listViewID 2 1 "21";
setListViewItemText $listViewID 2 2 "Male";
setListViewItemText $listViewID 3 1 "44";
setListViewItemText $listViewID 3 2 "Female";
 
// Set the check box to true for the males.
setListViewItemCheck $listViewID 0 true;
setListViewItemCheck $listViewID 2 true;
 
// Change Bob's name
setListViewItemText $listViewID 0 0 "Ken";
 
// Select Mary and Jim 
selectListViewItem $listViewID 2 true;
selectListViewItem $listViewID 1 true;
 
// Print out some of what we just did
print( `getListViewSelItems $listViewID` );
print( `getListViewItemText $listViewID 1 2` );
print( `getListViewItemCheck $listViewID 1` );
print( `getListViewItemCheck $listViewID 0` );
layoutForm $formID;
```

# Additional information

## Related commands

- [addListViewItem](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737177)
- [createListView](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737803)
- [deleteAllListViewItems](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737469)
- [getListViewSelItems](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736753)
- [getNumListViewItems](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736852)
- [selectListViewItem](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253739440)
- [setListViewColumns](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253738749)
- [setListViewHandler](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737377)
- [setListViewItemCheck](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737441)
- [setListViewItemText](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737858)