Version

WebDropDown class Members

The following tables list the members exposed by WebDropDown.

Public Constructors
 NameDescription
Public ConstructorWebDropDown Constructor  
Public Properties
 NameDescription
Public PropertyactiveItemreturns a reference to the current active item, if any  
Public PropertyactiveItemIndexfor internal use  
Public PropertyautoFilterQueryTypeWe support a predefined set of automatic server-side filtering queries, such as StartsWith, EndsWith, Contains, etc. We support a predefined set of automatic server-side filtering queries, such as StartsWith, EndsWith, Contains, etc.  
Public PropertyautoFilterResultSizemaximum number of items to return when a filtering request is made maximum number of items to return when a filtering request is made  
Public PropertyautoFilterSortOrderwe support sorting of the resulting items (ascending and descending) The sorting order of items when filtering  
Public PropertyautoFilterTimeoutMsmilliseconds that will pass while the user is typing, until a postback will be made this means we don't do a postback on every keystroke in the input box, in order to fetch filtering results milliseconds that will pass while the user is typing, until an async postback will be made  
Public PropertyautoSelectOnMatchautomatically selects the matched item value indicating whether to automatically select the matched item  
Public PropertybuttonCssClass  
Public PropertybuttonDisabledImageUrlthe Url for the dropdown button when it is pressed returns the Url for the dropdown disabled button image  
Public PropertybuttonHoverImageUrlthe Url for the dropdown button when it is hovered returns the Url for the dropdown hover button image  
Public PropertybuttonNormalImageUrlthe Url for the dropdown button when in normal state returns the Url for the dropdown button image  
Public PropertybuttonPressedImageUrlthe Url for the dropdown button when it is pressed returns the Url for the dropdown pressed button image  
Public PropertycloseDropDownOnSelectif the dropdown is opened, and we select an item, the dropdown container will be automatically closed if this property is enabled Indicates whether the dropdown container will be closed once an item is selected  
Public PropertycontrolAreaCssClass  
Public PropertycontrolAreaFocusCssClass  
Public PropertycontrolAreaHoverCssClass  
Public PropertycontrolCssClassthe css class that will be applied on the control's div indicates the CssClass for the control's Div element  
Public PropertycontrolDisabledCssClassthe css class that will be applied on the control's div when the control is disabled indicates the CssClass for disabled state of the control  
Public PropertycurrentValue'currentValue' is the value in the input box of the dropdown control. It could be assumed to mean the "Display Value". The setter accepts two parameters: set_currentValue(val, copyToInputValue). 'val' represents the text of the current value and 'copyToInputValue' is a Boolean value that if 'true', updates the input element's value. 'currentValue' is the value in the input box of the dropdown control. It could be assumed to mean the "Display Value"  
Public PropertydataSource  
Public PropertydisplayModedisplay mode can be DropDown (full-blown), DropDownList(dropdown with selection), ReadOnlyList (dropdown readonly) and ReadOnly (only input box) the dropdown display mode  
Public PropertydropDownAnimationDurationthe animation duration in milliseconds of the dropdown container The animation duration in milliseconds  
Public PropertydropDownAnimationTypelook at the $IG.AnimationEquationType enum, for the list of available enums the animation equation type  
Public PropertydropDownContainerHeightfixed height of the dropdown container height of the dropdown container  
Public PropertydropDownContainerWidthfixed width of the dropdown container width of the dropdown container  
Public PropertydropDownFocusCssClassthe css class that will be applied on the control's div when the control has focus indicates the CssClass when the control is focused (applied on the main control DIV)  
Public PropertydropDownHoverCssClassindicates the CssClass when the mouse is over the control  
Public PropertydropDownIsChildindicates whether the dropdown container will be attached directly to the body of the document, or will be a first child of the table where the input box is contained indicates whether the dropdown container will be attached directly to the body of the document, or will be a first child of the table where the input box is contained  
Public PropertydropDownOrientationorientation of the dropdown container relative to its target (input box) the orientation of the dropdown container  
Public PropertydropDownValueDisplayType  
Public PropertyeditorIDeditorID is the client side ID of the editor control, if we have associated any Infragistics built-in editors and want to use them in place of the vanilla input box editorID is the client side ID of the editor control, if we have associated any Infragistics built-in editors  
Public PropertyenableAnimationsEnable animations for the dropdown container Indicates whether animations are enabled or not  
Public PropertyenableAutoCompleteFirstMatchif this property is enabled, when we type text in the dropdown input box, once a match is made, it will be automatically completed and the remaining text will be highlighted if this property is enabled, when we type text in the dropdown input box, once a match is made, it will be automatically completed and the remaining text will be highlighted  
Public PropertyenableAutoFilteringsets the type of automatic filtering: Server,Client or Off (selection-only) value indicating the type of automatic filtering: Server,Client or Off (selection-only)  
Public PropertyenableCachingOnClientenables caching filtering results on the client, for that purpose a hashtable is used where the key is the search string enables caching filtering results on the client, for that purpose a hashtable is used where the key is the search string  
Public PropertyenableCaseSensitivityEnables case sensitivity when filtering is done on the client-cide indicates whether filtering is case sensitive or not (applies for client-side filtering only)  
Public PropertyenableClosingDropDownOnBlurif the control loses focus, and the dropdown container is opened, it will be automatically closed if the control loses focus, and the dropdown container is opened, it will be automatically closed  
Public PropertyenableCustomValuesenables or disables custom text in the input box enables or disables custom text in the input box  
Public PropertyenableCustomValueSelectionitems marked "Custom" will not be allowed for selection, if this property is turned on items marked "Custom" will not be allowed for selection, if this property is turned on  
Public PropertyenabledIndicates whether the whole control is enabled or not (if it is editable, and can be opened, items selected, etc.)  
Public PropertyenableDropDownContainerAutoWidthWidth of the dropdown container is going to grow with the contents value indicating if the Width of the dropdown container is going to grow with the contents  
Public PropertyenableDropDownOpenOnClickfor internal use  
Public PropertyenableLoadOnDemandload on demand is a kind of "virtual scrolling" where , once the user scrolls down to the bottom of the dropdown container new items are fetched from the server, if any indicates whether load on demand is enabled  
Public PropertyenableMarkingMatchedTextIf enabled, the matched (full or partial) text in the items will be marked in em tags If true, the matched (full or partial) text in the items will be marked in em tags  
Public PropertyenableMultipleSelectionsets / enables multiple selection in general. Further, multiple selection can be either implemented with checkboxes or with sets / enables multiple selection in general. Further, multiple selection can be either implemented with checkboxes  
Public PropertyenablePagingEnables paging value indicating if paging is enabled  
Public PropertyhoverItemIndexfor internal use  
Public PropertyinputCssClassthe css class that will be applied on the input box indicates the CssClass for the input box  
Public PropertyinputDisabledCssClassthe css class that will be applied on the input box when the control is disabled indicates the CssClass for disabled input state  
Public PropertyinputFocusCssClassthe css class that will be applied when the control has focus indicates the CssClass for Focus state  
Public PropertyinputHoverCssClassthe css class that will be applied when the control is hovered with the mouse indicates the CssClass for Hover state  
Public PropertyitemsThe collection of DropDownItem in the WebDropDown.  
Public PropertykeepFocusOnSelectionkeeps focus after selecting an item with the mouse keeps focus after selecting an item with the mouse  
Public PropertylastPageIndex  
Public PropertyloadingItemsMessageTextshows a loading message while the AJAX postback to request more items is executing shows a loading message while the AJAX postback to request more items is executing  
Public PropertymultipleSelectionTypetype of multiple selection - Keyboard or Checkbox (if checkbox, checkboxes are automatically rendered in front of every item) type of multiple selection - Keyboard or Checkbox  
Public PropertymultiSelectValueDelimiterthis represents a single character that will automatically delimit in the input box the list of multiple-selected items this represents a single character that will automatically delimit in the input box the list of multiple-selected items  
Public PropertynullTextnullText is default text that's shown when the control doesn't have focus nullText is default text that's shown when the control doesn't have focus  
Public PropertynullTextCssClassthe css class that will be applied when the control has focus indicates the CssClass for Focus state  
Public PropertyoffsetXhorizontal offset in pixels of the dropdown container relative to the target (allows for manual adjustment of the source and target) horizontal offset in pixels of the dropdown container relative to the target (allows for manual adjustment of the source and target)  
Public PropertyoffsetYvertical offset in pixels of the dropdown container relative to the target (allows for manual adjustment of the source and target) vertical offset in pixels of the dropdown container relative to the target (allows for manual adjustment of the source and target)  
Public PropertypageCountnumber of pages when paging is enabled returns the number of pages when paging is enabled  
Public PropertypagerModepager mode (numeric, first-last, etc.) paging mode  
Public PropertypageSizenumber of drop down items on a single page Page size when paging is enabled (number of items)  
Public PropertypersistCustomValuesenables / disables persisting of custom values. If some value that doesn't exist in the list is typed, and we remove the focus from the control, a new item is created, and marked IsCustom=true, and persisted to the server persisting of custom values SHOULD NOT be enabled along with loadOnDemand or Paging ! or with enables / disables persisting of custom values.  
Public PropertypreviousValuefor internal use  
Public PropertyselectedItemReturns the selected dropdown item  
Public PropertyselectedItemIndexIndex of the currently selected item The index of the selected item if any. If there is no selection, -1 is returned.  
Public PropertyselectedItemIndicesarray of selected item indices an array of selected items' indices when multiple selection is enabled  
Public PropertyselectedItemsReturns the array of DropDown items that are selected  
Public PropertyshouldFireMultipleSelect  
Public PropertyshowDropDownButtonif false, the dropdown button will be hidden and the input box will be the only visible element where filtering can be done indicates whether dropdown button will be shown or not  
Public Propertytemplate  
Public PropertyvalueBeforeFilter  
Public PropertyvalueListMaxHeightif not set this will be zero by default. If greater than zero, scrollbars will be added once contents exceed the max height if not set this will be zero by default. If greater than zero, scrollbars will be added once contents exceed the max height  
Public Methods
 NameDescription
Public MethodclearFilterClears the applied filter programmatically.  
Public MethodcloseDropDownCauses the dropdown container to close. Client-side Events (DropDownClosing/Closed) will be fired.  
Public MethoddataBind  
Public MethoddisposeClears all attached event handlers and additional references  
Public Methodfilterinvokes filtering programatically. Filtering will be executed on the text that's currently in the input box  
Public MethodfindFinds WebDropDown by its client ID.  
Public MethodfromCasts passed in object to the WebDropDown type.  
Public Methodinitialize  
Public MethodinvalidateCacheClears all cached items on the client, when EnableCachingOnClient=true  
Public MethodloadItemsthis function allows a developer to programatically populate the dropdown with items, based on certain filtering criteria  
Public MethodopenDropDownCauses the dropdown container to open. Client-side Events (DropDownOpening/Opened) will be fired.  
Public MethodselectItemSelects an item and optionally activates it and updates the current value and input text usage: selectItem(myItem,activate,updateCurrentValue); if the second parameter is true, the item will be also activated if the third parameter is true, the current value and the input text will also be updated this works for both Single (EnableMultipleSelection=false) and Multiple selections the default values for the second and third parameters are both 'true'  
Public MethodselectItemByIndexsame as selectItem(), but uses the passed item index instead: usage: selectItemByIndex(2)  
See Also