Documentation

Getting Started

The jqxListBox represents a jQuery listbox widget that contains a list of selectable items.
Every UI widget from jQWidgets toolkit needs its JavaScript files to be included in order to work properly.

The first step is to create html page and add links to the javascript files and css dependencies to your project. The jqxListBox widget requires the following files: 

<head>
<link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css"/>
<script type="text/javascript" src="../../scripts/jquery-1.11.1.min.js"></script>
<script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
<script type="text/javascript" src="../../jqwidgets/jqxbuttons.js"></script>
<script type="text/javascript" src="../../jqwidgets/jqxscrollbar.js"></script>
<script type="text/javascript" src="../../jqwidgets/jqxlistbox.js"></script>
 <script async src="https://www.googletagmanager.com/gtag/js?id=G-2FX5PV9DNT"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-2FX5PV9DNT');</script></head>

The next step is to create a div element within the body of the html document. 
<div id='jqxlistbox'>
</div>

The last step is to initialize the widget by adding the following script to the html document: 
var source = [
    "Instant coffee",
    "Irish coffee",
    "Liqueur coffee"
];
// Create a jqxListBox
$("#jqxlistbox").jqxListBox({ source: source, width: '200px', height: '250px',});

To call a function(method), you need to pass the method name and parameters(if any) in the jqxListBox’s constructor. 
$("#jqxlistbox").jqxListBox(‘selectIndex’, 1);
To get the result of a function(method) call, you need to pass the method name in the jqxListBox’s constructor. 
$("#jqxlistbox").jqxListBox(‘getSelectedIndex’);
To set a property(option), you need to pass the property name and value(s) in the jqxListBox's constructor. 
$("#jqxlistbox").jqxListBox({ checkboxes: false });
To get a property(option), you need to pass the property name to the jqxListBox's constructor. 
var checkboxes = $("#jqxlistbox").jqxListBox('checkboxes');
To bind to an event of a UI widget, you can use basic jQuery syntax. Let’s suppose that you want to get the selected item when the user clicks. The example code below demonstrates how to bind to the ‘select’ event of jqxListBox. 
$('#jqxListBox').on('select', function (event) {
    var args = event.args;
    var item = $('#jqxListBox').jqxListBox('getItem', args.index);
});

Basic Sample

The result of the above code is:

Bind the ListBox to JSON data

To bind the ListBox to JSON, XML, CSV, TSV or Array, you need to use the jqx.dataAdapter plug-in and also to set the ListBox's displayMember and valueMember properties to point to data source fields. 
<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="keywords" content="jQuery DropDownList, List, ListBox, Popup List, jqxDropDownList, jqxListBox, List Widget, ListBox Widget, DropDownList Widget" />
    <meta name="description" content="The jqxListBox represents a widget that contains a list of selectable items." />
    <title id='Description'>In this demo the jqxListBox is bound to JSON data.</title>
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/jquery-1.11.1.min.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxdata.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxbuttons.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxscrollbar.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxlistbox.js"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-2FX5PV9DNT"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'G-2FX5PV9DNT');</script></head>
<body>
    <div id='content'>
        <script type="text/javascript">
            $(document).ready(function () {
                // prepare the data
                var source =
                {
                    datatype: "json",
                    datafields: [
                        { name: 'CompanyName' },
                        { name: 'ContactName' }
                    ],
                    id: 'id',
                    url: 'customers.txt'
                };
             
                var dataAdapter = new $.jqx.dataAdapter(source);
                // Create a jqxListBox
                $("#jqxWidget").jqxListBox({ source: dataAdapter, displayMember: "ContactName", valueMember: "CompanyName", width: 200, height: 250, theme: '' });
                $("#jqxWidget").bind('select', function (event) {
                    if (event.args) {
                        var item = event.args.item;
                        if (item) {
                            var valueelement = $("<div></div>");
                            valueelement.html("Value: " + item.value);
                            var labelelement = $("<div></div>");
                            labelelement.html("Label: " + item.label);
                            $("#selectionlog").children().remove();
                            $("#selectionlog").append(labelelement);
                            $("#selectionlog").append(valueelement);
                        }
                    }
                });
            });
        </script>
        <div id='jqxWidget'>
        </div>
        <div id="selectionlog"></div>
    </div>
</body>
</html>

The result of the above code is:

Below is the JSON data that we use as a data source

Bind the ListBox to XML data

To bind the ListBox to JSON, XML, CSV, TSV or Array, you need to use the jqx.dataAdapter plug-in and also to set the ListBox's displayMember and valueMember properties to point to data source fields.

The result of the above code is:

Below is the XML data that we use as a data source