# ListControl Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (4.0.0.0) * [Control](https://docs.wisej.com/api/wisej.web/general/control) * [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) Provides a common implementation of members for the [ListBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/listbox) and [ComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/combobox) classes. {% tabs %} {% tab title="C#" %} ```csharp public class ListControl : Control, IValidation, IModified ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class ListControl Inherits Control Implements IValidation, IModified ``` {% endtab %} {% endtabs %} ## Properties ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) AllowHtml [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value indicating that the control can display HTML in the Text property. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) AllowSelection [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns a value indicating whether the list enables selection of list items. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BorderStyle [BorderStyle](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.borderstyle): Returns or sets the type of border that is drawn around the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `Solid`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataSource [Object](https://docs.microsoft.com/dotnet/api/system.object): Returns or sets the data source for this [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `null`) **Throws:** * [ArgumentException](https://docs.microsoft.com/dotnet/api/system.argumentexception)\ The assigned value does not implement the [IList](https://docs.microsoft.com/dotnet/api/system.collections.ilist) or [IListSource](https://docs.microsoft.com/dotnet/api/system.componentmodel.ilistsource) interfaces. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DisplayMember [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the property to display for this [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormatInfo [IFormatProvider](https://docs.microsoft.com/dotnet/api/system.iformatprovider): Returns or sets the [IFormatProvider](https://docs.microsoft.com/dotnet/api/system.iformatprovider) that provides custom formatting behavior. (Default: `null`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormatString [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the format-specifier characters that indicate how a value is to be displayed. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormattingEnabled [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether formatting is applied to the [DisplayMember](#displaymember) property of the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) IconMember [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the property to use as the icon for the items in the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Invalid [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value that indicates that the control is invalid. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) InvalidMessage [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the invalid message that is shown in the invalid tooltip. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Modified [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) PrefetchItems [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the number of items to prefetch outside of the visible area when [VirtualScroll](#virtualscroll) is set to true. The default is 0 (disabled). (Default: `0`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SelectedIndex [Int32](https://docs.microsoft.com/dotnet/api/system.int32): When overridden in a derived class, gets or sets the zero-based index of the currently selected item. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SelectedValue [Object](https://docs.microsoft.com/dotnet/api/system.object): Returns or sets the value of the member property specified by the [ValueMember](#valuemember) property. (Default: `null`) **Throws:** * [InvalidOperationException](https://docs.microsoft.com/dotnet/api/system.invalidoperationexception)\ The assigned value is null or the empty string (""). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ShowToolTips [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns or sets whether to show tooltips (set using [ToolTipMember](#tooltipmember)) for the list items. (Default: `False`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ToolTipMember [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the property to use as the tooltip for the items in the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol), when the property [ShowToolTips](#showtooltips) is set to true. (Default: `""`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ValueMember [String](https://docs.microsoft.com/dotnet/api/system.string): Returns or sets the property to use as the actual value for the items in the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). (Default: `""`) **Throws:** * [ArgumentException](https://docs.microsoft.com/dotnet/api/system.argumentexception)\ The specified property cannot be found on the object specified by the [DataSource](#datasource) property. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) VirtualScroll [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Enables or disables virtual scrolling for the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol). When virtual scrolling is enabled, only the visible items are rendered in the browser allowing the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) to host virtually unlimited items without any performance loss. (Default: `False`) When [VirtualScroll](#virtualscroll) is set to true, all the items must be of the same height, limiting the more flexible HTML rendering available when [VirtualScroll](#virtualscroll) is off (default).\ Setting the property [PrefetchItems](#prefetchitems) to a value greater than 0 allows the virtual view to prefetch the specified number of items outside of the visible area to enable smoother scrolling.**Throws:** * [InvalidOperationException](https://docs.microsoft.com/dotnet/api/system.invalidoperationexception)\ Horizontal orientation is not supported with virtual scrolling. ## Methods ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Append(data) Populates the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) from the *data* appending the items to the existing items. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **data** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object that contains data for the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) to display. | **Returns:** [Int32](https://docs.microsoft.com/dotnet/api/system.int32). Numbers of items appended. Use this method to fill a [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) without binding it to the data source. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) Dispose(disposing) Dispose the control. | Parameter | Type | Description | | ------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------- | | **disposing** | [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) | true when this method is called by the application rather than a finalizer. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Fill(data) Populates the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) from the *data* . | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **data** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object that contains data for the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) to display. | **Returns:** [Int32](https://docs.microsoft.com/dotnet/api/system.int32). Numbers of items added. Use this method to fill a [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) without binding it to the data source. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) FilterItemOnProperty(item) Retrieves the current value of the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) item, if it is a property of an object, given the item. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) item is bound to. | **Returns:** [Object](https://docs.microsoft.com/dotnet/api/system.object). The filtered object. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) FilterItemOnProperty(item, field) Returns the current value of the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) item, if it is a property of an object given the item and the property name. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) item is bound to. | | **field** | [String](https://docs.microsoft.com/dotnet/api/system.string) | The property name of the item the [ListControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol) is bound to. | **Returns:** [Object](https://docs.microsoft.com/dotnet/api/system.object). The filtered object. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetItemIcon(item) Returns the icon object, either an instance of [Image](https://docs.microsoft.com/dotnet/api/system.drawing.image) or a [String](https://docs.microsoft.com/dotnet/api/system.string) representing the icon name or URL, of the specified item. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ------------------------------------------------------------------- | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object from which to get the icon to display for the list item. | **Returns:** [Object](https://docs.microsoft.com/dotnet/api/system.object). If the [IconMember](#iconmember) property is not specified, the value returned by [GetItemIcon](#getitemicon-item) is null. Otherwise, the method returns the object value of the member specified in the [IconMember](#iconmember) property for the object specified in the *item* parameter. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetItemText(item) Returns the text representation of the specified item. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ----------------------------------------------------- | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object from which to get the contents to display. | **Returns:** [String](https://docs.microsoft.com/dotnet/api/system.string). If the [DisplayMember](#displaymember) property is not specified, the value returned by [GetItemText](#getitemtext-item) is the value of the item's ToString method. Otherwise, the method returns the string value of the member specified in the [DisplayMember](#displaymember) property for the object specified in the *item* parameter. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) GetItemToolTip(item) Returns the tooltip text related to the object. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object from which to get the tooltip text to display for the list item. | **Returns:** [String](https://docs.microsoft.com/dotnet/api/system.string). If the [ToolTipMember](#tooltipmember) property is not specified, the value returned by [GetItemToolTip](#getitemtooltip-item) is null. Otherwise, the method returns the value of the member specified in the [ToolTipMember](#tooltipmember) property for the object specified in the *item* parameter. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) IsInputKey(keyData) Handles special input keys, such as PAGE UP, PAGE DOWN, HOME, END, and so on. | Parameter | Type | Description | | ----------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | | **keyData** | [Keys](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.keys) | One of the values of [Keys](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.keys). | **Returns:** [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean). true if the *keyData* parameter specifies the [End](https://docs.wisej.com/api/enumerations/wisej.web.keys#fields), [Home](https://docs.wisej.com/api/enumerations/wisej.web.keys#fields), [PageUp](https://docs.wisej.com/api/enumerations/wisej.web.keys#fields), or [PageDown](https://docs.wisej.com/api/enumerations/wisej.web.keys#fields) key; false if the *keyData* parameter specifies [Alt](https://docs.wisej.com/api/enumerations/wisej.web.keys#fields). ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnBindingContextChanged(e) Fires the [BindingContextChanged](https://docs.wisej.com/api/general/control#bindingcontextchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnDataSourceChanged(e) Fires the [DataSourceChanged](#datasourcechanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnDisplayMemberChanged(e) Fires the [DisplayMemberChanged](#displaymemberchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnFormat(e) Raises the [Format](#format) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **e** | [ListControlConvertEventArgs](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol/wisej.web.listcontrolconverteventargs) | A [ListControlConvertEventArgs](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol/wisej.web.listcontrolconverteventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnFormatInfoChanged(e) Fires the [FormatInfoChanged](#formatinfochanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnFormatStringChanged(e) Fires the [FormatStringChanged](#formatstringchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnFormattingEnabledChanged(e) Fires the [FormattingEnabledChanged](#formattingenabledchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnIconMemberChanged(e) Fires the [IconMemberChanged](#iconmemberchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnModifiedChanged(e) Fires the [ModifiedChanged](#modifiedchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnSelectedIndexChanged(e) Fires the [SelectedValueChanged](#selectedvaluechanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnSelectedValueChanged(e) Fires the [SelectedValueChanged](#selectedvaluechanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnToolTipMemberChanged(e) Fires the [ToolTipMemberChanged](#tooltipmemberchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnValidating(e) Fires the [Validating](https://docs.wisej.com/api/general/control#validating) event. | Parameter | Type | Description | | --------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | **e** | [CancelEventArgs](https://docs.microsoft.com/dotnet/api/system.componentmodel.canceleventargs) | A [CancelEventArgs](https://docs.microsoft.com/dotnet/api/system.componentmodel.canceleventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnValueMemberChanged(e) Fires the [ValueMemberChanged](#valuememberchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebRender(config) Renders the client component. | Parameter | Type | Description | | ---------- | ------------------------------------------------------------- | ----------------------------- | | **config** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic configuration object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) RefreshItem(index) When overridden in a derived class, resynchronizes the data of the object at the specified index with the contents of the data source. | Parameter | Type | Description | | --------- | ----------------------------------------------------------- | ------------------------------------------------------- | | **index** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The zero-based index of the item whose data to refresh. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) RefreshItems() When overridden in a derived class, resynchronizes the item data with the contents of the data source. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) RenderItem(item) Renders the text representation of the specified item. If AllowHtml is set to false, the text is encoded. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ----------------------------------------------------- | | **item** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object from which to get the contents to display. | **Returns:** [Object](https://docs.microsoft.com/dotnet/api/system.object). If the [DisplayMember](#displaymember) property is not specified, the value returned by [GetItemText](#getitemtext-item) is the value of the item's ToString method. Otherwise, the method returns the string value of the member specified in the [DisplayMember](#displaymember) property for the object specified in the *item* parameter. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) SetItemCore(index, value) When overridden in a derived class, sets the object with the specified index in the derived class. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | ------------------------------ | | **index** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The array index of the object. | | **value** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) SetItemsCore(items) When overridden in a derived class, sets the specified array of objects in a collection in the derived class. | Parameter | Type | Description | | --------- | ----------------------------------------------------------------------- | ------------------ | | **items** | [IList](https://docs.microsoft.com/dotnet/api/system.collections.ilist) | An array of items. | ## Events ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DataSourceChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [DataSource](#datasource) changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) DisplayMemberChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [DisplayMember](#displaymember) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Format [ListControlConvertEventHandler](https://docs.wisej.com/api/wisej.web/lists-and-grids/listcontrol/wisej.web.listcontrolconverteventhandler) Fired when the control is bound to a data value. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormatInfoChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of the [FormatInfo](#formatinfo) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormatStringChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when value of the [FormatString](#formatstring) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) FormattingEnabledChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of the [FormattingEnabled](#formattingenabled) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) IconMemberChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [IconMember](#iconmember) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ModifiedChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of the [Modified](#modified) property has changed. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SelectedValueChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [SelectedValue](#selectedvalue) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ToolTipMemberChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [ToolTipMember](#tooltipmember) property changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ValueMemberChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the [ValueMember](#valuemember) property changes. ## Inherited By | Name | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [CheckedListBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/checkedlistbox) | Displays a [ListBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/listbox) in which a check box is displayed to the left of each item. | | [ComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/combobox) | Represents a combo box control. | | [ListBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/listbox) | Represents a control to display a list of items. | | [DataGridViewComboBoxEditingControl](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewcomboboxeditingcontrol) | Represents a [ComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/combobox) control that can be hosted in a [DataGridViewComboBoxCell](https://docs.wisej.com/api/wisej.web/lists-and-grids/datagridview/wisej.web.datagridviewcomboboxcell). | | [ListViewComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.listviewcombobox) | The TreeViewComboBox control represents a [UserComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.usercombobox) control with a [ListView](https://docs.wisej.com/api/wisej.web/lists-and-grids/listview) as the drop down panel. | | [TreeViewComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.treeviewcombobox) | The TreeViewComboBox control represents a [UserComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.usercombobox) control with a [TreeView](https://docs.wisej.com/api/wisej.web/lists-and-grids/treeview) as the drop down panel. | | [UserComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/wisej.web.usercombobox) | The UserComboBox control represents a [ComboBox](https://docs.wisej.com/api/wisej.web/lists-and-grids/combobox) control with a custom panel that drops down when the user clicks the down arrow. | ## Implements | Name | Description | | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [IUserData](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | | [IBindableComponent](https://docs.wisej.com/api/wisej.web/data-binding/wisej.web.ibindablecomponent) | Bindable components implement this interface. | | [IDropTarget](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.idroptarget) | Controls that support drag & drop operations implement this interface. | | [IModified](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.imodified) | Provides access to the [Modified](https://docs.wisej.com/api/interfaces/wisej.web.imodified#modified) property and [ModifiedChanged](https://docs.wisej.com/api/interfaces/wisej.web.imodified#modifiedchanged) event for controls that implement this interface. | | [IValidation](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.ivalidation) | Provides access to the validation events and properties property for controls that support validation. | | [IWisejComponent](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejControl](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcontrol) | All wisej controls derived from the [Control](https://docs.wisej.com/api/wisej.web/general/control) class must implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |