Click or drag to resize
KaxComboBox Class
KaxComboBox for ASP.NET AJAX is a powerful drop-down list AJAX-based 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.ControlsKaxComboBox

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)
Syntax
public class KaxComboBox : ControlItemContainer, 
	IPostBackEventHandler, ICallbackEventHandler, IEditableTextControl, ITextControl, ILocalizableControl

The KaxComboBox type exposes the following members.

Constructors
  NameDescription
Public methodKaxComboBox
Top
Methods
  NameDescription
Public methodCode exampleClearSelection

Clears out the list selection and sets the Selected property of all items to false.

Public methodDataBind
Binds a data source to the invoked KaxComboBox and all its child controls. Does not bind the control if EnableAutomaticLoadOnDemand is true and the page request is not a callback.
(Overrides BaseDataBoundControlDataBind.)
Public methodCode exampleFindItem
Returns the first KaxComboBoxItem that matches the conditions defined by the specified predicate. The predicate should returns a boolean value.
Public methodCode exampleFindItemByText(String)
Finds the first KaxComboBoxItem with Text that matches the given text value.
Public methodCode exampleFindItemByText(String, Boolean)
Finds the first KaxComboBoxItem with Text that matches the given text value.
Public methodCode exampleFindItemByValue(String)
Finds the first KaxComboBoxItem with Value that matches the given value.
Public methodCode exampleFindItemByValue(String, Boolean)
Finds the first KaxComboBoxItem with Value that matches the given value.
Public methodFindItemIndexByText(String)
Returns the index of the first KaxComboBoxItem with Text that matches the given text value.
Public methodFindItemIndexByText(String, Boolean)
Returns the index of the first KaxComboBoxItem with Text that matches the given text value.
Public methodFindItemIndexByValue(String)
Returns the index of the first KaxComboBoxItem with Value that matches the given value.
Public methodFindItemIndexByValue(String, Boolean)
Returns the index of the first KaxComboBoxItem with Value that matches the given value.
Public methodCode exampleLoadContentFile
Loads combobox items from an XML content file.
Public methodRenderBeginTag (Overrides KaxDataBoundControl.RenderBeginTag(HtmlTextWriter).)
Public methodRenderEndTag (Overrides KaxDataBoundControl.RenderEndTag(HtmlTextWriter).)
Public methodCode exampleSortItems
Sorts the items in the KaxComboBox.
Public methodCode exampleSortItems(IComparer)
Sorts the items in the KaxComboBox.
Top
Properties
  NameDescription
Public propertyAccessibilityMode

Determines whether the noscript tag containing select element to be rendered.

Public propertyAllowCustomText

Determines whether custom text can be entered into the input field of KaxComboBox.

Public propertyCode exampleAutoCompleteSeparator
Gets or sets a list of separators: autocomplete logic is reset afer a separator is entered and users can autocomplete multiple items.
Public propertyAutoPostBack
Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the KaxComboBox selection.
Public propertyChangeTextOnKeyBoardNavigation

Determines whether the text can be entered into the input field of KaxComboBox during keyboard navigation

Public propertyCode exampleClientChanges
Gets a list of all client-side changes (adding an item, removing an item, changing an item's property) which have occurred.
Public propertyCloseDropDownOnBlur

Determines whether drop down should be closed on blur

Public propertyCode exampleCollapseAnimation
Gets the settings for the animation played when an item closes.
Public propertyCode exampleCollapseDelay
Gets or sets a value indicating the timeout after which a dropdown starts to close.
Public propertyControls (Overrides ControlControls.)
Public propertyCulture
Public propertyDropDownCssClass
Gets or sets an additional Cascading Style Sheet (CSS) class applied to the Drop Down.
Public propertyDropDownWidth
Gets or sets the width of the dropdown in pixels.
Public propertyEmptyMessage
Public propertyEnableAutomaticLoadOnDemand
Gets or sets a value indicating whether the combobox should handle the items request automatically on the server.
Public propertyEnableItemBindingExpressions
Gets or sets a value indicating whether any databinding expressions specified in the ItemTemplate should be evaluated for unbound items (items added inline or programmatically).
Public propertyEnableItemCaching
Gets or sets a value indicating whether the combobox should cache items loaded on demand or via webservice
Public propertyEnableLoadOnDemand
Gets or sets a value indicating whether the combobox should issue a callback to the server whenever end-users change the text of the combo (keypress, paste, etc).
Public propertyEnableScreenBoundaryDetection

Determines whether the Screen Boundaries Detection is enabled or not.

Public propertyEnableTextSelection
Gets or sets a value indicating whether the text of combobox should be selected
Public propertyEnableVirtualScrolling
Gets or sets a value indicating whether the combobox should load items on demand (via callback) during scrolling-down the drop-down area.
Public propertyErrorMessage

Determines the custom error message to be shown after the Load On Demand Callback error appears.

Public propertyCode exampleExpandAnimation
Gets the settings for the animation played when the dropdown opens.
Public propertyCode exampleExpandDelay
Gets or sets a value indicating the timeout after which a dropdown starts to open.
Public propertyExpandDirection
Gets or sets a value indicating the opening direction of KaxComboBox dropdown. If this property is not set - by default dropdown opens downwards.
Public propertyFilter
Gets or sets a value indicating whether the combobox should automatically autocomplete and highlight the currently typed text to the all items text match.
Public propertyFooter
Get a footer of KaxcomboBox.
Public propertyFooterTemplate
Gets or sets the template for displaying footer in KaxcomboBox.
Public propertyHeader
Get a header of KaxcomboBox.
Public propertyHeaderTemplate
Gets or sets the template for displaying header in KaxcomboBox.
Public propertyHighlightTemplatedItems
Gets or sets a value indicating whether items defined in the ItemTemplate template should be automatically highlighted on mouse hover or keyboard navigation.
Public propertyIsCaseSensitive
Gets or sets a value that indicates whether the combobox autocompletion logic is case-sensitive or not.
Public propertyCode exampleIsEmpty
Gets a value indicating whether the current instance of the combobox has child items.
Public propertyItemRequestTimeout
Specifies the timeout after each keypress before KaxComboBox fires an AJAX callback to the ItemsRequested server-side event.
Public propertyCode exampleItems
Gets a KaxComboBoxItemCollection object that contains the items of the current KaxComboBox control.
Public propertyItemsPerRequest
Gets or sets the number of Items the KaxComboBox will load per Item request.
Public propertyCode exampleItemTemplate
Gets or sets the template for displaying the items in KaxcomboBox.
Public propertyCode exampleKaxComboBoxImagePosition
Sets or gets the position (left or right) of the arrow image dropdown.
Public propertyLabel
Public propertyLabelCssClass
Public propertyLoadingMessage
The value of the message that is shown in KaxComboBox while AJAX callback call is in effect.
Public propertyLocalization
Public propertyMarkFirstMatch
Gets or sets a value indicating whether the combobox should automatically autocomplete and highlight the currently typed text to the closest item text match.
Public propertyMaxHeight
Gets or sets the max height of the dropdown in pixels.
Public propertyMaxLength
Gets or sets the maximum number of characters allowed in the combobox.
Public propertyNoWrap

Gets or sets a value indicating whether the text in a combobox item automatically continues on the next line when it reaches the end of the dropdown.

Public propertyOffsetX
Gets or sets a value indicating the horizontal offset of the combobox dropdown
Public propertyOffsetY
Gets or sets a value indicating the vertical offset of the combobox dropdown.
Public propertyCode exampleOnClientBlur
The client-side event that is fired when when the combo loses focus
Public propertyCode exampleOnClientDropDownClosed
The client-side event that is fired after the dropdown of the combobox is closed.
Public propertyCode exampleOnClientDropDownClosing
The client-side event that is fired before the dropdown of the combobox is closed.
Public propertyCode exampleOnClientDropDownOpened
The client-side event that is fired after the dropdown of the combobox is opened.
Public propertyCode exampleOnClientDropDownOpening
The client-side event that is fired before the dropdown of the combobox is opened.
Public propertyCode exampleOnClientFocus
The client-side event that is fired when when the combo gains focus
Public propertyOnClientItemDataBound
Gets or sets the name of the JavaScript function called when an Item is created during Web Service Load on Demand.
Public propertyCode exampleOnClientItemsRequested
Gets or sets a value indicating the client-side event handler that is called when the KaxComboBox items were just populated (for example from web service).
Public propertyCode exampleOnClientItemsRequestFailed
Gets or sets a value indicating the client-side event handler that is called when the operation for populating the KaxComboBox has failed.
Public propertyCode exampleOnClientItemsRequesting
Gets or sets a value indicating the client-side event handler that is called when the KaxComboBox is about to be populated (for example from web service).
Public propertyCode exampleOnClientKeyPressing
The client-side event that is fired when the user presses a key inside the combobox.
Public propertyCode exampleOnClientLoad
Gets or sets a value indicating the client-side event handler that is called after the KaxComboBox client-side object is initialized.
Public propertyCode exampleOnClientSelectedIndexChanged
The client-side event that is fired after the selected index of the KaxComboBox has been changed.
Public propertyCode exampleOnClientSelectedIndexChanging
The client-side event that is fired when the selected index of the KaxComboBox is about to be changed.
Public propertyOnClientTextChange
Public propertyOpenDropDownOnLoad
Gets or sets a value that indicates whether the dropdown of the combobox should be opened by default on loadnig the page.
Public propertySelectedIndex

Gets the index of the currently selected item in the combobox.

Public propertyCode exampleSelectedItem

Gets the currently selected item in the combobox.

Public propertySelectedValue

Gets the value of the currently selected item in the combobox.

Public propertyShowDropDownOnTextboxClick

Determines whether the dropdown shows when the user clicks in the input field.

Public propertyShowMoreResultsBox
Gets or sets a value indicating whether the combobox should display the box for requesting additional items
Public propertyShowToggleImage
Gets or sets a value indicating whether the dropdown image next to the combobox text area should be displayed.
Public propertyShowWhileLoading
Indicates whether the combobox will be visible while loading.
Public propertyCode exampleSort
Automatically sorts items alphabetically (based on the Text property) in ascending or descending order.
Public propertyCode exampleSortCaseSensitive
Gets/sets whether the sorting will be case-sensitive or not. By default is set to true.
Public propertyCode exampleText

Gets or sets the text content of the KaxComboBox control.

Public propertyUniqueID (Overrides ControlUniqueID.)
Public propertyWebServiceSettings
Gets the settings for the web service used to populate items.
Public propertyZIndex
The HTML Z-index of the items dropdown of KaxComboBox.Its default value is 6000.
Top
Events
  NameDescription
Public eventItemCreated
Occurs on the server when an item in the KaxComboBox control is created.
Public eventItemDataBound

Occurs after an item is data bound to the KaxComboBox control.

Public eventItemsRequested
Occurs when KaxComboBox initiates an AJAX callback to the server.
Public eventSelectedIndexChanged
Occurs when the SelectedIndex property has changed.
Public eventCode exampleTemplateNeeded
Occurs before template is being applied to the item.
Public eventTextChanged
Occurs when the text of the KaxComboBox changes between postbacks to the server.
Top
Remarks

The KaxComboBox control supports the following features:

  • Databinding that allows the control to be populated from various datasources
  • Programmatic access to the KaxComboBox object model which allows to dynamic creation of comboboxes, populate items, set properties.
  • Customizable appearance through built-in or user-defined skins.

Items

Each item has a Text and a Value property. The value of the Text property is displayed in the KaxComboBox control, while the Value property is used to store any additional data about the item, such as data passed to the postback event associated with the item.

See Also