KaxListBox Class

KaxListBox Class

KaxListBox is a flexible listbox control with the some unique features: Rich and highly customizable UI for item transfer, delete and reordering. Drag and drop support. Items can be reordered or transferred via drag and drop. Automatic update of the underlying data source during reorder, transfer or delete. Checkbox support All features supported by the built-in ListBox control.

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsDataBoundControl
          KaxDataBoundControl
            Kettic.AspNet.ControlsControlItemContainer
              Kettic.AspNet.ControlsKaxListBox

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

public class KaxListBox : ControlItemContainer, IPostBackEventHandler, 
	ILocalizableControl

Public Class KaxListBox
	Inherits ControlItemContainer
	Implements IPostBackEventHandler, ILocalizableControl

public ref class KaxListBox : public ControlItemContainer, 
	IPostBackEventHandler, ILocalizableControl

type KaxListBox =  
    class
        inherit ControlItemContainer
        interface IPostBackEventHandler
        interface ILocalizableControl
    end

The KaxListBox type exposes the following members.

Constructors

	Name	Description
	KaxListBox

Top

Methods

	Name	Description
	ClearChecked	Clears the checked items. The Checked property of all items is set to false.
	ClearSelection	Clears the selection. The Selected property of all items is set to false.
	Delete(KaxListBoxItem)	Deletes the specified item. Fires the Deleting and Deleted events.
	Delete(IListKaxListBoxItem)	Deletes the specified list of items. Fires the Deleting and Deleted events.
	FindItem	Finds the first item for which the specified predicate returns true.
	FindItemByText	Finds the first item whose Text property is the same as the specified text.
	FindItemByValue	Finds the first item whose Value property is the same as the specified value.
	FindItemIndexByValue(String)	Finds the index of the item whose Value property is the same as the specified value.
	FindItemIndexByValue(String, Boolean)	Finds the index of the item whose Value property is the same as the specified value.
	GetCheckedIndices	Gets an array containing the indices of the currently checked items in the KaxListBox control.
	GetSelectedIndices	Gets an array containing the indices of the currently selected items in the KaxListBox control.
	LoadContentFile	Populates the KaxListBox control from an XML file
	Reorder(Int32, Int32)	Moves the item at old index to new index by calculating the offset. Fires the Reordering and Reordered events.
	Reorder(IListKaxListBoxItem, Int32)	Reorders the specified items with the specified offset. Fires the Reordering and Reordered events.
	ReorderToIndex(Int32, Int32)	Moves the item at old index to new index. Fires the Reordering and Reordered events.
	ReorderToIndex(IListKaxListBoxItem, Int32)	Reorders the specified items to the specified index. Fires the Reordering and Reordered events.
	SortItems	Sorts the items in the KaxListBox.
	Transfer(KaxListBoxItem, KaxListBox, KaxListBox)	Transfers the specified item from the source list box to the destination listbox. Fires the Transferring and Transferred events.
	Transfer(IListKaxListBoxItem, KaxListBox, KaxListBox)	Transfers the specified list of items from the source to the destination listbox. Fires the Transferring and Transferred events.

Top

Properties

	Name	Description
	AllowAutomaticUpdates	Gets or sets a value indicating whether to update the underlying datasource after postback caused by reorder, delete or transfer.
	AllowDelete	Gets or sets a value indicating whether KaxListBox displays the delte button.
	AllowReorder	Gets or sets a value indicating whether KaxListBox displays the reordering buttons.
	AllowTransfer	Gets or sets a value indicating whether KaxListBox displays the transfer buttons.
	AllowTransferDuplicates	Gets or sets a value indicating whether the user can transfer the same item more than once.
	AllowTransferOnDoubleClick	Gets or sets a value indicating whether the double click on a item causes transfer
	AutoPostBack	Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the KaxListBox selection.
	AutoPostBackOnDelete	Gets or sets a value indicating whether KaxListBox should post back after delete.
	AutoPostBackOnReorder	Gets or sets a value indicating whether KaxListBox should post back after reorder.
	AutoPostBackOnTransfer	Gets or sets a value indicating whether KaxListBox should post back after transfer.
	ButtonSettings	Used to customize the appearance and position of the buttons displayed by KaxListBox.
	CheckBoxes	When set to true displays a checkbox next to each item.
	CheckedItems	Gets the currently checked items in the ListBox.
	ClientChanges	Gets a list of all client-side changes (adding an Item, removing an Item, changing an Item's property) which have occurred.
	Controls	(Overrides ControlControls.)
	Culture
	DataKeyField	Gets or sets the key field in the data source. Usually this is the database column which denotes the primary key.
	DataKeys	Gets a DataKeyCollection object that stores the key values of each record.
	DataSortField	Gets or sets the sort field in the data source. The sort field must be of numeric type.
	EmptyMessage
	EmptyMessageTemplate	Gets or sets the ITemplate that defines the KaxListBox empty message template.
	EnableDragAndDrop	When set to true enables Drag-and-drop functionality
	EnableMarkMatches
	Footer	Get a footer of KaxListBox.
	FooterTemplate	Gets or sets the ITemplate that defines the KaxListBox footer template.
	Header	Get a header of KaxListBox.
	HeaderTemplate	Gets or sets the ITemplate that defines the KaxListBox header template.
	Items	Gets the items of the KaxListBox control.
	ItemTemplate	Gets or sets the ITemplate that defines how items in the KaxListBox control are displayed.
	Localization
	OnClientContextMenu	Gets or sets a value indicating the client-side event handler that is called before the browser context panel shows (after right-clicking an item).
	OnClientDeleted	Gets or sets the name of the JavaScript function which handles the deleted client-side event.
	OnClientDeleting	Gets or sets the name of the JavaScript function which handles the deleting client-side event.
	OnClientDragging	Gets or sets the name of the JavaScript function which handles the itemDragging client-side event.
	OnClientDragStart	Gets or sets the name of the JavaScript function which handles the itemDragStart client-side event.
	OnClientDropped	Gets or sets the name of the JavaScript function which handles the itemDropped client-side event.
	OnClientDropping	Gets or sets the name of the JavaScript function which handles the itemDropping client-side event.
	OnClientItemChecked	Gets or sets the name of the JavaScript function which handles the itemChecked client-side event.
	OnClientItemChecking	Gets or sets the name of the JavaScript function which handles the itemChecking client-side event.
	OnClientItemDoubleClicked
	OnClientItemDoubleClicking
	OnClientLoad	Gets or sets the name of the JavaScript function which handles the load client-side event.
	OnClientMouseOut	Gets or sets the name of the JavaScript function which handles the mouseOut client-side event.
	OnClientMouseOver	Gets or sets the name of the JavaScript function which handles the mouseOver client-side event.
	OnClientReordered	Gets or sets the name of the JavaScript function which handles the reordered client-side event.
	OnClientReordering	Gets or sets the name of the JavaScript function which handles the reordering client-side event.
	OnClientSelectedIndexChanged	Gets or sets the name of the JavaScript function which handles the selectedIndexChanged client-side event.
	OnClientSelectedIndexChanging	Gets or sets the name of the JavaScript function which handles the selectedIndexChanging client-side event.
	OnClientTransferred	Gets or sets the name of the JavaScript function which handles the transferred client-side event.
	OnClientTransferring	Gets or sets the name of the JavaScript function which handles the transferring client-side event.
	PersistClientChanges	Gets or sets a value indicating whether KaxListBox should persist the changes that occurred client-side (reorder, transfer, delete) after postback.
	SelectedIndex	Gets or sets the selected index of the KaxListBox control.
	SelectedItem	Gets the currently selected Item in the ListBox.
	SelectedItems	Gets the currently selected items in the ListBox.
	SelectedValue	Gets the Value of the selected item. When set selects the item with matching Value property.
	SelectionMode	Gets or sets the Selection Mode of the KaxListBox.
	Sort	Automatically sorts items alphabetically (based on the Text property) in ascending or descending order.
	SortCaseSensitive	Gets/sets whether the sorting will be case-sensitive or not. By default is set to true.
	TransferMode	Gets or sets the transfer mode used for transfer operations.
	TransferToID	Gets or sets the ID of the KaxListBox which the current listbox should transfer to. Set the TransferToID property only of one of the two listboxes which will transfer items between each other.
	TransferToListBox	Gets the KaxListBox which the current list box is configured to transfer to via the TransferToID property.

Top

Events

	Name	Description
	Deleted	Occurs when items are deleted.
	Deleting	Occurs when items are deleted.
	Dropped	Occurs after drag and drop
	Dropping	Occurs before drag and drop
	Inserted	Occurs when item is inserted.
	Inserting	Occurs when item is inserted. Can be cancelled by setting the Cancel property to true.
	ItemCheck	Occurs when an item is checked
	ItemCreated	Occurs when item is created.
	ItemDataBound	Occurs when item is data bound.
	Reordered	Occurs when item is reordered.
	Reordering	Occurs when item is reordered. Can be cancelled by setting the Cancel property to true.
	SelectedIndexChanged	Occurs when the selected index has changed.
	TemplateNeeded	Occurs before template is being applied to the item.
	TextChanged	Occurs when text was changed.
	Transferred	Occurs when item is transferred.
	Transferring	Occurs when item is transferred. Can be cancelled by setting the Cancel property to true.
	Updated	Occurs when items's sort order is updated during the reordering.
	Updating	Occurs when items's sort order is updated during the reordering.

Top

Reference

Kettic.AspNet.Controls Namespace