<div class="header-panel member">
<h2><span class="identifier">ListBox</span> Class</h2>
<dl class="dl-horizontal">
<dt>File</dt><dd class="filename">wijmo.input.js</dd>
<dt>Module</dt><dd><a href="topic/wijmo.input.Module.html"><span class="identifier">wijmo.input</span></a></dd>
<dt>Base Class</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
<dt>Derived Classes</dt><dd><a href="topic/wijmo-wijmo.angular2.input.WjListBox.Class.html"><span class="identifier">WjListBox</span></a></dd>
<dt>Show</dt>
<dd>
<label><input type="checkbox" ng-model="ctx.showInherited"> Inherited Members</label>&nbsp;&nbsp;&nbsp;
<label><input type="checkbox" ng-model="ctx.showRaisers"> Event Raisers</label>
</dd>
</dl>
<div class="comment"><p>The <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> control displays a list of items which may contain 
plain text or HTML, and allows users to select items with the mouse
or the keyboard.</p>
<p>Use the <a href="topic/wijmo.input.ListBox.Class.html/#selectedIndex"><span class="identifier">selectedIndex</span></a> property to determine which item 
is currently selected.</p>
<p>You can populate a <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> using an array of strings or you can 
use an array of objects, in which case the <a href="topic/wijmo.input.ListBox.Class.html/#displayMemberPath"><span class="identifier">displayMemberPath</span></a>
property determines which object property is displayed on the list.</p>
<p>To display items that contain HTML rather than plain text, set the
<a href="topic/wijmo.input.ListBox.Class.html/#isContentHtml"><span class="identifier">isContentHtml</span></a> property to true.</p>
<p>The <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> control supports the following keyboard commands:</p>
<p><table>
  <thead>
    <tr><th>Key Combination</th><th>Action</th></tr>
  </thead>
  <tbody>
    <tr><td>Up/Down</td><td>Select the previous/next item</td></tr>
    <tr><td>PageUp/Down</td><td>Select the item one page above or below the selection</td></tr>
    <tr><td>Home/End</td><td>Select the first/last items</td></tr>
    <tr><td>Space</td><td>Toggle the checkbox in the current item (see the <a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath"><span class="identifier">checkedMemberPath</span></a> property)</td></tr>
    <tr><td>Other characters</td><td>Search for items that contain the text typed (multi-character auto-search)</td></tr>
  </tbody>
</table></p>
<p>The example below creates a <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> control and populates it using
a 'countries' array. The control updates its <a href="topic/wijmo.input.ListBox.Class.html/#selectedIndex"><span class="identifier">selectedIndex</span></a>
and <a href="topic/wijmo.input.ListBox.Class.html/#selectedItem"><span class="identifier">selectedItem</span></a> properties as the user moves the selection.</p>
<p><div class="member-panel example"><h3 class="node collapsed">Example</h3><div class="fiddle"><script async src="https://jsfiddle.net/Wijmo5/8HnLx/embed/result,html,js,css"></script></div></div></p></div>
</div>
<div class="member-panel class members" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<h3 class="node">Constructor</h3>
<ul>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#constructor">constructor</a></li>
</ul>
<h3 class="node">Properties</h3>
<ul>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#checkedItems">checkedItems</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath">checkedMemberPath</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#collectionView">collectionView</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#displayMemberPath">displayMemberPath</a></li>
<li class="mproperty inherited"><a href="topic/wijmo.input.ListBox.Class.html/#hostElement">hostElement</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#isContentHtml">isContentHtml</a></li>
<li class="mproperty inherited"><a href="topic/wijmo.input.ListBox.Class.html/#isDisabled">isDisabled</a></li>
<li class="mproperty inherited"><a href="topic/wijmo.input.ListBox.Class.html/#isTouching">isTouching</a></li>
<li class="mproperty inherited"><a href="topic/wijmo.input.ListBox.Class.html/#isUpdating">isUpdating</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#itemFormatter">itemFormatter</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#itemRole">itemRole</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#itemsSource">itemsSource</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#maxHeight">maxHeight</a></li>
<li class="mproperty inherited"><a href="topic/wijmo.input.ListBox.Class.html/#rightToLeft">rightToLeft</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#selectedIndex">selectedIndex</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#selectedItem">selectedItem</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#selectedValue">selectedValue</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#selectedValuePath">selectedValuePath</a></li>
<li class="mproperty"><a href="topic/wijmo.input.ListBox.Class.html/#showGroups">showGroups</a></li>
</ul>
<h3 class="node">Methods</h3>
<ul>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#addEventListener">addEventListener</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#applyTemplate">applyTemplate</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#beginUpdate">beginUpdate</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#containsFocus">containsFocus</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#deferUpdate">deferUpdate</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#dispose">dispose</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#disposeAll">disposeAll</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#endUpdate">endUpdate</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#focus">focus</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#getControl">getControl</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#getDisplayText">getDisplayText</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#getDisplayValue">getDisplayValue</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#getItemChecked">getItemChecked</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#getTemplate">getTemplate</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#indexOf">indexOf</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#initialize">initialize</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#invalidate">invalidate</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#invalidateAll">invalidateAll</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#isItemEnabled">isItemEnabled</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#loadList">loadList</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onCheckedItemsChanged">onCheckedItemsChanged</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onFormatItem">onFormatItem</a></li>
<li class="mmethod inherited raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onGotFocus">onGotFocus</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onItemChecked">onItemChecked</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onItemsChanged">onItemsChanged</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onLoadedItems">onLoadedItems</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onLoadingItems">onLoadingItems</a></li>
<li class="mmethod inherited raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onLostFocus">onLostFocus</a></li>
<li class="mmethod inherited raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onRefreshed">onRefreshed</a></li>
<li class="mmethod inherited raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onRefreshing">onRefreshing</a></li>
<li class="mmethod raiser"><a href="topic/wijmo.input.ListBox.Class.html/#onSelectedIndexChanged">onSelectedIndexChanged</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#refresh">refresh</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#refreshAll">refreshAll</a></li>
<li class="mmethod inherited"><a href="topic/wijmo.input.ListBox.Class.html/#removeEventListener">removeEventListener</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#setItemChecked">setItemChecked</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#showSelection">showSelection</a></li>
<li class="mmethod"><a href="topic/wijmo.input.ListBox.Class.html/#toggleItemChecked">toggleItemChecked</a></li>
</ul>
<h3 class="node">Events</h3>
<ul>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#checkedItemsChanged">checkedItemsChanged</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#formatItem">formatItem</a></li>
<li class="mevent inherited"><a href="topic/wijmo.input.ListBox.Class.html/#gotFocus">gotFocus</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#itemChecked">itemChecked</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#itemsChanged">itemsChanged</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#loadedItems">loadedItems</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#loadingItems">loadingItems</a></li>
<li class="mevent inherited"><a href="topic/wijmo.input.ListBox.Class.html/#lostFocus">lostFocus</a></li>
<li class="mevent inherited"><a href="topic/wijmo.input.ListBox.Class.html/#refreshed">refreshed</a></li>
<li class="mevent inherited"><a href="topic/wijmo.input.ListBox.Class.html/#refreshing">refreshing</a></li>
<li class="mevent"><a href="topic/wijmo.input.ListBox.Class.html/#selectedIndexChanged">selectedIndexChanged</a></li>
</ul>
</div>
<h3>Constructor</h3>
<div id="constructor" class="member-panel mmethod">
<h3>constructor</h3>
<pre>constructor(element: <span class="identifier">any</span>, options?): <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a></pre>
<div class="comment"><p>Initializes a new instance of the <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> class.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>element</b>: <span class="identifier">any</span><br/><p>The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').</p></li><li><b>options</b>:  <span class="badge">Optional</span><br/><p>The JavaScript object containing initialization data for the control.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a></dd>
</dl>
</div>
<h3 class="node">Properties</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="checkedItems" class="member-panel mproperty">
<h3>checkedItems</h3>
<div class="comment"><p>Gets or sets an array containing the items that are currently checked.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><span class="identifier">any</span>[]</dd>
</dl>
</div>
<div id="checkedMemberPath" class="member-panel mproperty">
<h3>checkedMemberPath</h3>
<div class="comment"><p>Gets or sets the name of the property used to control 
check boxes placed next to each item.</p>
<p>Use this property to create multi-select LisBoxes.</p>
<p>When an item is checked or unchecked, the control raises the
<a href="topic/wijmo.input.ListBox.Class.html/#itemChecked"><span class="identifier">itemChecked</span></a> event.</p>
<p>Use the <a href="topic/wijmo.input.ListBox.Class.html/#selectedItem"><span class="identifier">selectedItem</span></a> property to retrieve the item that
was checked or unchecked, or use the <a href="topic/wijmo.input.ListBox.Class.html/#checkedItems"><span class="identifier">checkedItems</span></a> property 
to retrieve the list of items that are currently checked.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd></dd>
</dl>
</div>
<div id="collectionView" class="member-panel mproperty">
<h3>collectionView</h3>
<div class="comment"><p>Gets the <a href="topic/wijmo.collections.ICollectionView.Interface.html"><span class="identifier">ICollectionView</span></a> object used as the item source.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.collections.ICollectionView.Interface.html"><span class="identifier">ICollectionView</span></a></dd>
</dl>
</div>
<div id="displayMemberPath" class="member-panel mproperty">
<h3>displayMemberPath</h3>
<div class="comment"><p>Gets or sets the name of the property to use as the visual 
representation of the items.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="hostElement" class="member-panel mproperty inherited">
<h3>hostElement</h3>
<div class="comment"><p>Gets the DOM element that is hosting the control.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></dd>
</dl>
</div>
<div id="isContentHtml" class="member-panel mproperty">
<h3>isContentHtml</h3>
<div class="comment"><p>Gets or sets a value indicating whether items contain plain 
text or HTML.</p>
<p>The default value for this property is <b>false</b>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="isDisabled" class="member-panel mproperty inherited">
<h3>isDisabled</h3>
<div class="comment"><p>Gets or sets a value that determines whether the control is disabled.</p>
<p>Disabled controls cannot get mouse or keyboard events.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="isTouching" class="member-panel mproperty inherited">
<h3>isTouching</h3>
<div class="comment"><p>Gets a value that indicates whether the control is currently handling a touch event.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="isUpdating" class="member-panel mproperty inherited">
<h3>isUpdating</h3>
<div class="comment"><p>Gets a value that indicates whether the control is currently being updated.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="itemFormatter" class="member-panel mproperty">
<h3>itemFormatter</h3>
<div class="comment"><p>Gets or sets a function used to customize the values shown on 
the list.
The function takes two arguments, the item index and the default
text or html, and returns the new text or html to display.</p>
<p>If the formatting function needs a scope (i.e. a meaningful
'this' value), then remember to set the filter using the 'bind'
function to specify the 'this' object. For example:</p>


<pre>listBox.itemFormatter = customItemFormatter.bind(this);
  function customItemFormatter(index, content) {
    if (this.makeItemBold(index)) {
      content = '&lt;b&gt;' + content + '&lt;/b&gt;';
    }
    return content;
  }</pre></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank"><span class="identifier">Function</span></a></dd>
</dl>
</div>
<div id="itemRole" class="member-panel mproperty">
<h3>itemRole</h3>
<div class="comment"><p>Gets or sets the value or the "role" attribute added to the
list items. The default value for this property is "option".</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="itemsSource" class="member-panel mproperty">
<h3>itemsSource</h3>
<div class="comment"><p>Gets or sets the array or <a href="topic/wijmo.collections.ICollectionView.Interface.html"><span class="identifier">ICollectionView</span></a> object that contains
the list items.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><span class="identifier">any</span></dd>
</dl>
</div>
<div id="maxHeight" class="member-panel mproperty">
<h3>maxHeight</h3>
<div class="comment"><p>Gets or sets the maximum height of the list.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="rightToLeft" class="member-panel mproperty inherited">
<h3>rightToLeft</h3>
<div class="comment"><p>Gets a value indicating whether the control is hosted in an element
with right-to-left layout.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="selectedIndex" class="member-panel mproperty">
<h3>selectedIndex</h3>
<div class="comment"><p>Gets or sets the index of the currently selected item.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="selectedItem" class="member-panel mproperty">
<h3>selectedItem</h3>
<div class="comment"><p>Gets or sets the item that is currently selected.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><span class="identifier">any</span></dd>
</dl>
</div>
<div id="selectedValue" class="member-panel mproperty">
<h3>selectedValue</h3>
<div class="comment"><p>Gets or sets the value of the <a href="topic/wijmo.input.ListBox.Class.html/#selectedItem"><span class="identifier">selectedItem</span></a> obtained using 
the <a href="topic/wijmo.input.ListBox.Class.html/#selectedValuePath"><span class="identifier">selectedValuePath</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><span class="identifier">any</span></dd>
</dl>
</div>
<div id="selectedValuePath" class="member-panel mproperty">
<h3>selectedValuePath</h3>
<div class="comment"><p>Gets or sets the name of the property used to get the 
<a href="topic/wijmo.input.ListBox.Class.html/#selectedValue"><span class="identifier">selectedValue</span></a> from the <a href="topic/wijmo.input.ListBox.Class.html/#selectedItem"><span class="identifier">selectedItem</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="showGroups" class="member-panel mproperty">
<h3>showGroups</h3>
<div class="comment"><p>Gets or sets a value that determines whether the <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> should 
include group header items to delimit data groups.</p>
<p>Data groups are created by modifying the <a href="topic/wijmo.collections.ICollectionView.Interface.html/#groupDescriptions"><span class="identifier">groupDescriptions</span></a>
property of the <a href="topic/wijmo.collections.ICollectionView.Interface.html"><span class="identifier">ICollectionView</span></a> object used as an <a href="topic/wijmo.input.ListBox.Class.html/#itemsSource"><span class="identifier">itemsSource</span></a>.</p>
<p>The <a href="topic/wijmo.input.ListBox.Class.html"><span class="identifier">ListBox</span></a> only shows the first level of grouping.</p>
<p>The default value for this property is <b>false</b>.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
</div>
<h3 class="node">Methods</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="addEventListener" class="member-panel mmethod inherited">
<h3>addEventListener</h3>
<pre>addEventListener(target: <a href="https://developer.mozilla.org/en/docs/Web/API/EventTarget" target="_blank"><span class="identifier">EventTarget</span></a>, type: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a>, fn: <span class="identifier">any</span>, capture?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>, passive?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Adds an event listener to an element owned by this <a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a>.</p>
<p>The control keeps a list of attached listeners and their handlers,
making it easier to remove them when the control is disposed (see the
<a href="topic/wijmo.input.ListBox.Class.html/#dispose"><span class="identifier">dispose</span></a> and <a href="topic/wijmo.input.ListBox.Class.html/#removeEventListener"><span class="identifier">removeEventListener</span></a> methods).</p>
<p>Failing to remove event listeners may cause memory leaks.</p>
<p>The <b>passive</b> parameter is set to false by default, which means
the event handler may call <b>event.preventDefault()</b>.
If you are adding passive handlers to touch or wheel events, setting
this parameter to true will improve application performance.</p>
<p>For details on passive event listeners, please see 
<a target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Improving_scrolling_performance_with_passive_listeners">Improving scrolling performance with passive listeners</a>.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>target</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/EventTarget" target="_blank"><span class="identifier">EventTarget</span></a><br/><p>Target element for the event.</p></li><li><b>type</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a><br/><p>String that specifies the event.</p></li><li><b>fn</b>: <span class="identifier">any</span><br/><p>Function to execute when the event occurs.</p></li><li><b>capture</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Whether the listener should be handled by the control before it is handled by the target element.</p></li><li><b>passive</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Indicates that the handler will never call <b>preventDefault()</b>.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="applyTemplate" class="member-panel mmethod inherited">
<h3>applyTemplate</h3>
<pre>applyTemplate(classNames: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a>, template: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a>, parts: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank"><span class="identifier">Object</span></a>, namePart?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></pre>
<div class="comment"><p>Applies the template to a new instance of a control, and returns the root element.</p>
<p>This method should be called by constructors of templated controls.
It is responsible for binding the template parts to the 
corresponding control members.</p>
<p>For example, the code below applies a template to an instance
of an <a href="topic/wijmo.input.InputNumber.Class.html"><span class="identifier">InputNumber</span></a> control. The template must contain elements 
with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'.
The control members '_tbx', '_btnUp', and '_btnDn' will be assigned
references to these elements.</p>


<pre>this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');</pre></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>classNames</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a><br/><p>Names of classes to add to the control's host element.</p></li><li><b>template</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a><br/><p>An HTML string that defines the control template.</p></li><li><b>parts</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank"><span class="identifier">Object</span></a><br/><p>A dictionary of part variables and their names.</p></li><li><b>namePart</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a> <span class="badge">Optional</span><br/><p>Name of the part to be named after the host element. This
determines how the control submits data when used in forms.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></dd>
</dl>
</div>
<div id="beginUpdate" class="member-panel mmethod inherited">
<h3>beginUpdate</h3>
<pre>beginUpdate(): <span class="identifier">void</span></pre>
<div class="comment"><p>Suspends notifications until the next call to <a href="topic/wijmo.input.ListBox.Class.html/#endUpdate"><span class="identifier">endUpdate</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="containsFocus" class="member-panel mmethod inherited">
<h3>containsFocus</h3>
<pre>containsFocus(): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></pre>
<div class="comment"><p>Checks whether this control contains the focused element.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="deferUpdate" class="member-panel mmethod inherited">
<h3>deferUpdate</h3>
<pre>deferUpdate(fn: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank"><span class="identifier">Function</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Executes a function within a <a href="topic/wijmo.input.ListBox.Class.html/#beginUpdate"><span class="identifier">beginUpdate</span></a>/<a href="topic/wijmo.input.ListBox.Class.html/#endUpdate"><span class="identifier">endUpdate</span></a> block.</p>
<p>The control will not be updated until the function has been executed.
This method ensures <a href="topic/wijmo.input.ListBox.Class.html/#endUpdate"><span class="identifier">endUpdate</span></a> is called even if the function throws
an exception.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>fn</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank"><span class="identifier">Function</span></a><br/><p>Function to be executed.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="dispose" class="member-panel mmethod inherited">
<h3>dispose</h3>
<pre>dispose(): <span class="identifier">void</span></pre>
<div class="comment"><p>Disposes of the control by removing its association with the host element.</p>
<p>The <a href="topic/wijmo.input.ListBox.Class.html/#dispose"><span class="identifier">dispose</span></a> method automatically removes any event listeners added
with the <a href="topic/wijmo.input.ListBox.Class.html/#addEventListener"><span class="identifier">addEventListener</span></a> method.</p>
<p>Calling the <a href="topic/wijmo.input.ListBox.Class.html/#dispose"><span class="identifier">dispose</span></a> method is important in applications that create
and remove controls dynamically. Failing to dispose of the controls may
cause memory leaks.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="disposeAll" class="member-panel mmethod inherited">
<h3><span class="badge">Static</span> disposeAll</h3>
<pre>disposeAll(e?: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Disposes of all Wijmo controls contained in an HTML element.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a> <span class="badge">Optional</span><br/><p>Container element.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="endUpdate" class="member-panel mmethod inherited">
<h3>endUpdate</h3>
<pre>endUpdate(): <span class="identifier">void</span></pre>
<div class="comment"><p>Resumes notifications suspended by calls to <a href="topic/wijmo.input.ListBox.Class.html/#beginUpdate"><span class="identifier">beginUpdate</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="focus" class="member-panel mmethod inherited">
<h3>focus</h3>
<pre>focus(): <span class="identifier">void</span></pre>
<div class="comment"><p>Sets the focus to this control.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="getControl" class="member-panel mmethod inherited">
<h3><span class="badge">Static</span> getControl</h3>
<pre>getControl(element: <span class="identifier">any</span>): <a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></pre>
<div class="comment"><p>Gets the control that is hosted in a given DOM element.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>element</b>: <span class="identifier">any</span><br/><p>The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
</dl>
</div>
<div id="getDisplayText" class="member-panel mmethod">
<h3>getDisplayText</h3>
<pre>getDisplayText(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></pre>
<div class="comment"><p>Gets the text displayed for the item at a given index (as plain text).</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>The index of the item in the <a href="topic/wijmo.input.ListBox.Class.html/#itemsSource"><span class="identifier">itemsSource</span></a>.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="getDisplayValue" class="member-panel mmethod">
<h3>getDisplayValue</h3>
<pre>getDisplayValue(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></pre>
<div class="comment"><p>Gets the string displayed for the item at a given index.</p>
<p>The string may be plain text or HTML, depending on the setting
of the <a href="topic/wijmo.input.ListBox.Class.html/#isContentHtml"><span class="identifier">isContentHtml</span></a> property.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>The index of the item in the <a href="topic/wijmo.input.ListBox.Class.html/#itemsSource"><span class="identifier">itemsSource</span></a>.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="getItemChecked" class="member-panel mmethod">
<h3>getItemChecked</h3>
<pre>getItemChecked(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></pre>
<div class="comment"><p>Gets the checked state of an item on the list.</p>
<p>This method is applicable only on multi-select ListBoxes 
(see the <a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath"><span class="identifier">checkedMemberPath</span></a> property).</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>Item index.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="getTemplate" class="member-panel mmethod inherited">
<h3>getTemplate</h3>
<pre>getTemplate(): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></pre>
<div class="comment"><p>Gets the HTML template used to create instances of the control.</p>
<p>This method traverses up the class hierarchy to find the nearest 
ancestor that specifies a control template. For example, if you 
specify a prototype for the <a href="topic/wijmo.input.ComboBox.Class.html"><span class="identifier">ComboBox</span></a> control, which does
not specify a template, it will override the template defined 
by the <a href="topic/wijmo.input.DropDown.Class.html"><span class="identifier">DropDown</span></a> base class (the nearest ancestor that does
specify a template).</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a></dd>
</dl>
</div>
<div id="indexOf" class="member-panel mmethod">
<h3>indexOf</h3>
<pre>indexOf(e: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></pre>
<div class="comment"><p>Gets the data index of an element within the list.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a><br/><p>Element to search for.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="initialize" class="member-panel mmethod inherited">
<h3>initialize</h3>
<pre>initialize(options: <span class="identifier">any</span>): <span class="identifier">void</span></pre>
<div class="comment"><p>Initializes the control by copying the properties from a given object.</p>
<p>This method allows you to initialize controls using plain data objects
instead of setting the value of each property in code.</p>
<p>For example:
</p>

<pre>grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 } 
  ]
});

// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;

// etc.</pre>
<p>The initialization data is type-checked as it is applied. If the 
initialization object contains unknown property names or invalid
data types, this method will throw.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>options</b>: <span class="identifier">any</span><br/><p>Object that contains the initialization data.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="invalidate" class="member-panel mmethod inherited">
<h3>invalidate</h3>
<pre>invalidate(fullUpdate?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Invalidates the control causing an asynchronous refresh.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>fullUpdate</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Whether to update the control layout as well as the content.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="invalidateAll" class="member-panel mmethod inherited">
<h3><span class="badge">Static</span> invalidateAll</h3>
<pre>invalidateAll(e?: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Invalidates all Wijmo controls contained in an HTML element.</p>
<p>Use this method when your application has dynamic panels that change
the control's visibility or dimensions. For example, splitters, accordions,
and tab controls usually change the visibility of its content elements.
In this case, failing to notify the controls contained in the element
may cause them to stop working properly.</p>
<p>If this happens, you must handle the appropriate event in the dynamic
container and call the <a href="topic/wijmo.Control.Class.html/#invalidateAll"><span class="identifier">invalidateAll</span></a> method so the contained
Wijmo controls will update their layout information properly.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a> <span class="badge">Optional</span><br/><p>Container element. If set to null, all Wijmo controls
on the page will be invalidated.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="isItemEnabled" class="member-panel mmethod">
<h3>isItemEnabled</h3>
<pre>isItemEnabled(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Gets a value that determines whether the item at a given index is enabled.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>The index of the item in the <a href="topic/wijmo.input.ListBox.Class.html/#itemsSource"><span class="identifier">itemsSource</span></a>.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="loadList" class="member-panel mmethod">
<h3>loadList</h3>
<pre>loadList(): <span class="identifier">void</span></pre>
<div class="comment"><p>Loads the list with items from the current <a href="topic/wijmo.input.ListBox.Class.html/#itemsSource"><span class="identifier">itemsSource</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onCheckedItemsChanged" class="member-panel mmethod raiser">
<h3>onCheckedItemsChanged</h3>
<pre>onCheckedItemsChanged(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#checkedItemsChanged"><span class="identifier">checkedItemsChanged</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onFormatItem" class="member-panel mmethod raiser">
<h3>onFormatItem</h3>
<pre>onFormatItem(e: <a href="topic/wijmo.input.FormatItemEventArgs.Class.html"><span class="identifier">FormatItemEventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#formatItem"><span class="identifier">formatItem</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.input.FormatItemEventArgs.Class.html"><span class="identifier">FormatItemEventArgs</span></a><br/><p><a href="topic/wijmo.input.FormatItemEventArgs.Class.html"><span class="identifier">FormatItemEventArgs</span></a> that contains the event data.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onGotFocus" class="member-panel mmethod inherited raiser">
<h3>onGotFocus</h3>
<pre>onGotFocus(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#gotFocus"><span class="identifier">gotFocus</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onItemChecked" class="member-panel mmethod raiser">
<h3>onItemChecked</h3>
<pre>onItemChecked(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#itemChecked"><span class="identifier">itemChecked</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onItemsChanged" class="member-panel mmethod raiser">
<h3>onItemsChanged</h3>
<pre>onItemsChanged(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#itemsChanged"><span class="identifier">itemsChanged</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onLoadedItems" class="member-panel mmethod raiser">
<h3>onLoadedItems</h3>
<pre>onLoadedItems(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#loadedItems"><span class="identifier">loadedItems</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onLoadingItems" class="member-panel mmethod raiser">
<h3>onLoadingItems</h3>
<pre>onLoadingItems(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#loadingItems"><span class="identifier">loadingItems</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onLostFocus" class="member-panel mmethod inherited raiser">
<h3>onLostFocus</h3>
<pre>onLostFocus(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#lostFocus"><span class="identifier">lostFocus</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onRefreshed" class="member-panel mmethod inherited raiser">
<h3>onRefreshed</h3>
<pre>onRefreshed(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#refreshed"><span class="identifier">refreshed</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onRefreshing" class="member-panel mmethod inherited raiser">
<h3>onRefreshing</h3>
<pre>onRefreshing(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#refreshing"><span class="identifier">refreshing</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="onSelectedIndexChanged" class="member-panel mmethod raiser">
<h3>onSelectedIndexChanged</h3>
<pre>onSelectedIndexChanged(e?: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Raises the <a href="topic/wijmo.input.ListBox.Class.html/#selectedIndexChanged"><span class="identifier">selectedIndexChanged</span></a> event.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a> <span class="badge">Optional</span><br/></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="refresh" class="member-panel mmethod">
<h3>refresh</h3>
<pre>refresh(fullUpdate?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Refreshes the control.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>fullUpdate</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Whether to update the control layout as well as the content.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="refreshAll" class="member-panel mmethod inherited">
<h3><span class="badge">Static</span> refreshAll</h3>
<pre>refreshAll(e?: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Refreshes all Wijmo controls contained in an HTML element.</p>
<p>This method is similar to <a href="topic/wijmo.input.ListBox.Class.html/#invalidateAll"><span class="identifier">invalidateAll</span></a>, except the controls
are updated immediately rather than after an interval.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>e</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a> <span class="badge">Optional</span><br/><p>Container element. If set to null, all Wijmo controls
on the page will be invalidated.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="removeEventListener" class="member-panel mmethod inherited">
<h3>removeEventListener</h3>
<pre>removeEventListener(target?: <a href="https://developer.mozilla.org/en/docs/Web/API/EventTarget" target="_blank"><span class="identifier">EventTarget</span></a>, type?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a>, fn?: <span class="identifier">any</span>, capture?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></pre>
<div class="comment"><p>Removes one or more event listeners attached to elements owned by this <a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a>.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>target</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/EventTarget" target="_blank"><span class="identifier">EventTarget</span></a> <span class="badge">Optional</span><br/><p>Target element for the event. If null, removes listeners attached to all targets.</p></li><li><b>type</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank"><span class="identifier">string</span></a> <span class="badge">Optional</span><br/><p>String that specifies the event. If null, removes listeners attached to all events.</p></li><li><b>fn</b>: <span class="identifier">any</span> <span class="badge">Optional</span><br/><p>Handler to remove. If null, removes all handlers.</p></li><li><b>capture</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Whether the listener is capturing. If null, removes capturing and non-capturing listeners.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="setItemChecked" class="member-panel mmethod">
<h3>setItemChecked</h3>
<pre>setItemChecked(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>, checked: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Sets the checked state of an item on the list.</p>
<p>This method is applicable only on multi-select ListBoxes 
(see the <a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath"><span class="identifier">checkedMemberPath</span></a> property).</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>Item index.</p></li><li><b>checked</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a><br/><p>Item's new checked state.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="showSelection" class="member-panel mmethod">
<h3>showSelection</h3>
<pre>showSelection(setFocus?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Highlights the selected item and scrolls it into view.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>setFocus</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a> <span class="badge">Optional</span><br/><p>Whether to set the focus to the list after scrolling
the selected item into view.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
<div id="toggleItemChecked" class="member-panel mmethod">
<h3>toggleItemChecked</h3>
<pre>toggleItemChecked(index: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>): <span class="identifier">void</span></pre>
<div class="comment"><p>Toggles the checked state of an item on the list.
This method is applicable only to multi-select ListBoxes 
(see the <a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath"><span class="identifier">checkedMemberPath</span></a> property).</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>index</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>Item index.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><span class="identifier">void</span></dd>
</dl>
</div>
</div>
<h3 class="node">Events</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="checkedItemsChanged" class="member-panel mevent">
<h3>checkedItemsChanged</h3>
<div class="comment"><p>Occurs when the value of the <a href="topic/wijmo.input.ListBox.Class.html/#checkedItems"><span class="identifier">checkedItems</span></a> property changes.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="formatItem" class="member-panel mevent">
<h3>formatItem</h3>
<div class="comment"><p>Occurs when an element representing a list item has been created.</p>
<p>This event can be used to format list items for display. It is similar 
in purpose to the <a href="topic/wijmo.input.ListBox.Class.html/#itemFormatter"><span class="identifier">itemFormatter</span></a> property, but has the advantage 
of allowing multiple independent handlers.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.input.FormatItemEventArgs.Class.html"><span class="identifier">FormatItemEventArgs</span></a></dd>
</dl>
</div>
<div id="gotFocus" class="member-panel mevent inherited">
<h3>gotFocus</h3>
<div class="comment"><p>Occurs when the control gets the focus.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="itemChecked" class="member-panel mevent">
<h3>itemChecked</h3>
<div class="comment"><p>Occurs when the current item is checked or unchecked by the user.</p>
<p>This event is raised when the <a href="topic/wijmo.input.ListBox.Class.html/#checkedMemberPath"><span class="identifier">checkedMemberPath</span></a> is set to 
the name of a property to add check boxes to each item in the control.</p>
<p>Use the <a href="topic/wijmo.input.ListBox.Class.html/#selectedItem"><span class="identifier">selectedItem</span></a> property to retrieve the item that was 
checked or unchecked.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="itemsChanged" class="member-panel mevent">
<h3>itemsChanged</h3>
<div class="comment"><p>Occurs when the list of items changes.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="loadedItems" class="member-panel mevent">
<h3>loadedItems</h3>
<div class="comment"><p>Occurs after the list items have been generated.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="loadingItems" class="member-panel mevent">
<h3>loadingItems</h3>
<div class="comment"><p>Occurs before the list items are generated.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="lostFocus" class="member-panel mevent inherited">
<h3>lostFocus</h3>
<div class="comment"><p>Occurs when the control loses the focus.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="refreshed" class="member-panel mevent inherited">
<h3>refreshed</h3>
<div class="comment"><p>Occurs after the control has refreshed its contents.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="refreshing" class="member-panel mevent inherited">
<h3>refreshing</h3>
<div class="comment"><p>Occurs when the control is about to refresh its contents.</p></div>
<dl class="dl-horizontal">
  <dt>Inherited From</dt><dd><a href="topic/wijmo.Control.Class.html"><span class="identifier">Control</span></a></dd>
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
<div id="selectedIndexChanged" class="member-panel mevent">
<h3>selectedIndexChanged</h3>
<div class="comment"><p>Occurs when the value of the <a href="topic/wijmo.input.ListBox.Class.html/#selectedIndex"><span class="identifier">selectedIndex</span></a> property changes.</p></div>
<dl class="dl-horizontal">
  <dt>Arguments</dt><dd><a href="topic/wijmo.EventArgs.Class.html"><span class="identifier">EventArgs</span></a></dd>
</dl>
</div>
</div>
