ASP.NET ComboBox Control

About Us

Products

Downloads

Purchase

Support

ComboBox

Version 1.5

What's New

Overview

Features

Reference Book

Licensing

Support

Design

Layout and Behavior

Programming

APNSoft > Products > ComboBox > Server-side API

Show All Hide All

Properties

AutoPostBack

Specifies whether the ComboBox control causes a postback to the server when an Item is selected from the DropDown List. Default value is false.
EXAMPLE
AutoScrollList

Allows to enable content auto scrolling while the mouse cursor is moving over the opened DropDown List. Default value is false.
EXAMPLE

BasePage

Specifies the reference to the base page if component is used in Code Behind.

  [C#]
 
  myComboBox.BasePage = base.Page;

  [VB.NET]
  
  myComboBox.BasePage = Me.Page

CSSFileURL
Specifies the URL for the CSS File. If the property is not specified, the component uses internal default style. The property value can be an absolute or relative URI.
```
  [C#]
 
  myComboBox.CSSFileURL = "./Styles/Style.css";

  [VB.NET]
  
  myComboBox.CSSFileURL = "./Styles/Style.css"
```
MORE
ClientScriptSource
Specifies the source of the ComboBox client-side script code. The property uses the ClientScriptSourceValues enumeration. Default value is GeneratedByComponent.
```
  [C#]
 
  myComboBox.ClientScriptSource =
    APNSoftComboBox.ClientScriptSourceValues.ExternalFile;
    
  [VB.NET]
  
  myComboBox.ClientScriptSource = _
    APNSoftComboBox.ClientScriptSourceValues.ExternalFile
```
To use the external file with client-side script, you should:
1. Take the ComboBox.js file from the Download section and put it into the folder "Scripts", that is created in the root of your web application.
2. Set the property value to ExternalFile.
3. Add the instruction in the <head> section of your web page:
```
<script type="text/javascript" src="./Scripts/ComboBox.js"></script>
```
DefaultIcon
Specifies the image filename for the Default Icon if no items are selected from the DropDown List. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.DefaultIcon = "Search.gif";

  [VB.NET]
  
  myComboBox.DefaultIcon = "Search.gif"
```
MORE

DefaultText

Specifies the text if no items are selected from the DropDown List. The value by default is Select item from the list:.

  [C#]
 
  myComboBox.DefaultText = "Choose search engine:";

  [VB.NET]
  
  myComboBox.DefaultText = "Choose search engine:"

EnableViewState

Specifies the value indicating whether the server control persists its view state for use in round-trips. Default value is true.
ImagesFolderURL
Specifies the folder for all component images (icons, arrows, rulers, etc.). The property value can be an absolute or relative URI.
```
  [C#]
 
  myComboBox.ImagesFolderURL = "./Images/";

  [VB.NET]
  
  myComboBox.ImagesFolderURL = "./Images/"
```

Left

Specifies the left coordinate for the ComboBox, which positioned at an absolute position. Default value is 0.

  [C#]
 
  myComboBox.Left = 100;

  [VB.NET]
  
  myComboBox.Left = New System.Web.UI.WebControls.Unit(100)

EXAMPLE

LicenseFileName

Specifies the name of the file that includes component License Key. Default value is ComboBox_Lic.xml.
MORE
ListHeight
Specifies the DropDown List height in pixels. If the height of the List content is more than property value, the Slider is displayed automatically. Default value is 140.
```
  [C#]
 
  myComboBox.ListHeight = 200;

  [VB.NET]
  
  myComboBox.ListHeight = _
    New System.Web.UI.WebControls.Unit(200)
```
EXAMPLE
MainArrow
Specifies the image filename for the Main Arrow. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.MainArrow = "MainArrow.gif";

  [VB.NET]
  
  myComboBox.MainArrow = "MainArrow.gif"
```
MORE
MainArrowActive
Specifies the image filename for the Main Arrow when the DropDown List is opened. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.MainArrowActive = "MainArrowActive.gif";

  [VB.NET]
  
  myComboBox.MainArrowActive = "MainArrowActive.gif"
```
OnClientListItemClick
Specifies the name of a custom JavaScript function that will be fired when a DropDown List Item is clicked. The function must accept two parameters: ComponentID and ItemID.
```
  [C#]
 
  myComboBox.OnClientListItemClick = "ClientSideProcedure";

  [VB.NET]
  
  myComboBox.OnClientListItemClick = "ClientSideProcedure"
```
EXAMPLE
OnClientListItemOver
Specifies the name of a custom JavaScript function that will be fired while the mouse cursor is moving over the DropDown List Item.
The function must accept two parameters: ComponentID and ItemID.
```
  [C#]
 
  myComboBox.OnClientListItemOver = "ClientSideProcedure";

  [VB.NET]
  
  myComboBox.OnClientListItemOver = "ClientSideProcedure"
```
EXAMPLE

OpenListEvent

Specifies the client side event type to open DropDown List. The property uses the OpenListEventValues enumeration. Default value is OnMouseClick.

  [C#]
 
  myComboBox.OpenListEvent =
    APNSoftComboBox.OpenListEventValues.OnMouseOver;

  [VB.NET]
  
  myComboBox.OpenListEvent = _
    APNSoftComboBox.OpenListEventValues.OnMouseOver

EXAMPLE

Position
Specifies the absolute or static (relative) ComboBox position on the page. The property uses the PositionValues enumeration. Default value is Static. If you use ComboBox with absolute positioning, you need to set the Left and Top properties.
```
  [C#]
 
  myComboBox.Position =
    APNSoftComboBox.PositionValues.Absolute;
    
  [VB.NET]
  
  myComboBox.Position = _
    APNSoftComboBox.PositionValues.Absolute
```
EXAMPLE
SliderArrowUp
Specifies the image filename for the Slider Arrow Up. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderArrowUp = "SliderArrowUp.gif";

  [VB.NET]
  
  myComboBox.SliderArrowUp = "SliderArrowUp.gif"
```
MORE
SliderArrowUpActive
Specifies image filename for the Slider Arrow Up when the DropDown List content is scrolling up. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderArrowUpActive = "SliderArrowUpActive.gif";

  [VB.NET]
  
  myComboBox.SliderArrowUpActive = "SliderArrowUpActive.gif"
```
SliderArrowDown
Specifies the image filename for the Slider Arrow Down. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderArrowDown = "SliderArrowDown.gif";

  [VB.NET]
  
  myComboBox.SliderArrowDown = "SliderArrowDown.gif"
```
MORE
SliderArrowDownActive
Specifies the image filename for the Slider Arrow Down when the DropDown List content is scrolling down. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderArrowDownActive = 
    "SliderArrowDownActive.gif";

  [VB.NET]
  
  myComboBox.SliderArrowDownActive = _
    "SliderArrowDownActive.gif"
```
SliderRuler
Specifies the image filename for the Slider Ruler. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderRuler = "SliderRuler.gif";

  [VB.NET]
  
  myComboBox.SliderRuler = "SliderRuler.gif"
```
MORE
SliderRulerActive
Specifies the image filename for the Slider Ruler when the mouse cursor is clicked on the Ruler. The image file must be located in the Images Folder of your web site, as specified in the ImagesFolderURL property.
```
  [C#]
 
  myComboBox.SliderRulerActive = "SliderRulerActive.gif";

  [VB.NET]
  
  myComboBox.SliderRulerActive = "SliderRulerActive.gif"
```
SSLSecured

Specifies the value indicating whether the ComboBox works on a SSL secured site. Default value is false.

If the ComboBox works on a SSL secured site, you should set the property value to true. Also, you need to create the file called empty.htm in the same directory as your ASPX page. The content of the empty.htm is simply "<html></html>".
StructureFileURL
Specifies the URL for the ComboBox structure file. If the property is not specified, the component uses internal default structure (list of popular web search engines). The property value can be an absolute or relative URI.
```
  [C#]
 
  myComboBox.StructureFileURL = "./Structures/Structure.xml";

  [VB.NET]
  
  myComboBox.StructureFileURL = "./Structures/Structure.xml"
```
MORE
StructureXMLDocument
Specifies the ComboBox Structure XML Document. The property is used only in Code Behind and used for specifying component Structure programatically. Cancels the StructureFileURL property.
```
  [C#]
 
  myComboBox.StructureXMLDocument = (XmlDocument)myStructure;

  [VB.NET]
  
  myComboBox.StructureXMLDocument = _
    CType(myStructure, XmlDocument)
```
EXAMPLE

Top

Specifies the top coordinate for the ComboBox, which positioned at an absolute position. Default value is 0.

  [C#]
 
  myComboBox.Top = 100;

  [VB.NET]
  
  myComboBox.Top = New System.Web.UI.WebControls.Unit(100)

EXAMPLE

TransitionEffect
Provides an animated effect to display the DropDown List. Component supports six most popular effects. Works in Internet Explorer only. The property uses the TransitionEffectValues enumeration. Default value is None.
```
  [C#]
 
  myComboBox.TransitionEffect =
    APNSoftComboBox.TransitionEffectValues.GradientWipe;

  [VB.NET]
  
  myComboBox.TransitionEffect = _
    APNSoftComboBox.TransitionEffectValues.GradientWipe
```
EXAMPLE
WarningsEnabled

Specifies whether the ComboBox generates client-side JavaScript messages which allow developers control the component status. For example, if you use a new ComboBox version with the old JS file, you will see a warning. Default value is true.
Width
Specifies the ComboBox width in pixels. Note that the property value is equal or greater than the actual width of the DropDown List content. Default value is 220.
```
  [C#]
 
  myComboBox.Width = 300;

  [VB.NET]
  
  myComboBox.Width = New System.Web.UI.WebControls.Unit(300)
```
EXAMPLE
zIndex
Specifies the value of z-index for the layers are generated by the ComboBox. Default value is 200.
```
  [C#]
 
  myComboBox.zIndex = 300;

  [VB.NET]
  
  myComboBox.zIndex = 300
```

Methods

GetSelectedItemID
Returns the selected Item ID. When the form is returned after a postback, the selected Item ID can be defined by this method.
```
[C#]

string SelectedItemID = myComboBox.GetSelectedItemID();

[VB.NET]

Dim SelectedItemID As String = myComboBox.GetSelectedItemID
```

Enumerations

ClientScriptSourceValues
Values for the property ClientScriptSource.
- GeneratedByComponent = 0;
- ExternalFile = 1;
OpenListEventValues
Values for the property OpenListEvent.
- OnMouseClick = 0;
- OnMouseOver = 1;
PositionValues
Values for the property Position.
- Absolute = 0;
- Static = 1;
TransitionEffectValues
Values for the property TransitionEffect.
- None = 0;
- Blinds = 1;
- Fade = 2;
- GradientWipe = 3;
- Pixelate = 4;
- RandomBars = 5;
- RandomDissolve = 6;

Events

OnItemClick

Occurs on the server side when a DropDown List Item is clicked.

  [C#]
  
  myComboBox.AutoPostBack = true;
  
  myComboBox.OnItemClick +=
    new ComboBoxEventHandler(this.ServerSideProcedure);
				
  private void ServerSideProcedure(object sender,
    APNSoft.WebControls.ComboBoxEventArgs e)
  {
    Response.Write(e.ItemID);
  }


  [VB.NET]
  
  myComboBox.AutoPostBack = True

  AddHandler myComboBox.OnItemClick, _
    New APNSoft.WebControls.ComboBoxEventHandler( _
    AddressOf Me.ServerSideProcedure)
    
  Private Sub ServerSideProcedure( _
    ByVal sender As Object, _
    ByVal e As APNSoft.WebControls.ComboBoxEventArgs)

      Response.Write(e.ItemID)

  End Sub

EXAMPLE

Top of Page

Table of Contents Terms of use Contact Us Help Center

Controls Suite

DataGrid

TreeView

ComboBox

Include

	DataGrid
	Menu
	TreeView
	ComboBox
	Include