Public Instance Constructors

DbCombo Constructor Constructor - public DbCombo()

Public Instance Properties

AccessKey (inherited from System.Web.UI.WebControls.WebControl)
Attributes (inherited from System.Web.UI.WebControls.WebControl)
AutoPostBack If this is set to true, the control will postback when either an item is clicked on, or enter is pressed on an item. Default is false.
BackColor (inherited from System.Web.UI.WebControls.WebControl)
BindingContainer (inherited from System.Web.UI.Control)
BorderColor (inherited from System.Web.UI.WebControls.WebControl)
BorderStyle (inherited from System.Web.UI.WebControls.WebControl)
BorderWidth (inherited from System.Web.UI.WebControls.WebControl)
ClearQueryOnUpLevelSearchButton If this is set to true, clicking on the UpLevel search button will cause the contents of the text box to be cleared.
ClientID (inherited from System.Web.UI.Control)
ClientOnSelectFunction If specified, this javascript function is executed each time a DbCombo item is selected in the drop-down. IMPORTANT – you must NOT include the parenthesis after the name of your function. Your function must accept two strings as parameters. The first is DbCombo’s Value property; the second is the Text property. If we are unselecting from DbCombo, the value property is a blank string, and the Text property is set to whatever the textbox contains.
ClientStateFunction This client function enables you to pass information about the pages state back to your ServerMethod. This enables you to provide different results dependant on other form elements (e.g. drop-downs etc.) IMPORTANT – you must include the parenthesis after the name of your function. You may optionally include parameters to pass to the function. This function must return a javascript ‘Object’ object
CloseResultsOnBlur If this is set to false, the results stay visible when the DbCombo looses focus. Default is true.
CloseResultsOnClick If this is set to false, the results stay visible when an item is clicked on. Default is true.
CloseResultsOnEnter If this is set to false, the results stay visible when enter is pressed. Default is true.
CloseResultsOnTab If this is set to false, the results stay visible when tab is pressed. Default is true.
Controls (inherited from System.Web.UI.Control)
ControlStyle (inherited from System.Web.UI.WebControls.WebControl)
ControlStyleCreated (inherited from System.Web.UI.WebControls.WebControl)
CssClass (inherited from System.Web.UI.WebControls.WebControl)
DataMember Use the DataMember property to specify a member from a multimember data source. For example, if you have a data source with more than one table, use the DataMember property to specify which table to bind to. Leave blank for the default. Remember if you change this from it's default, you MUST change the ServerMethodEventArgs.DataMemberSecurity property in your ServerMethod.
DataTextField This is the name of the field in the dataset returned by the ServerMethod that will be used for the Text property of DbCombo. Remember if you change this from it's default value of 'DbComboText', you MUST change the ServerMethodEventArgs.FieldSecurity property in your ServerMethod.
DataValueField This is the name of the field in the dataset returned by the ServerMethod that will be used for the Value property of DbCombo. Remember if you change this from it's default value of 'DbComboValue', you MUST change the ServerMethodEventArgs.FieldSecurity property in your ServerMethod.
Debug Set this to true if you are having problems. It will redirect the output of the server component to the browser window.
DesignMode Used internally by design-time tools.
DisplayResultsInDesigner Set this to true if you want to preview how DbCombo will look in the designer. Please note that due to the lack of designer JavaScript support, the edges of the drop-down will not be hidden, and the up level search button will not be resized to the height of the text box.
DownLevelButtonClass This is the class html attribute of all the down-level buttons in the control
DownLevelButtonStyle This is the style html attribute of all the down-level buttons in the control
DropDownRows This sets the number of rows in the drop-box (defaults to 10)
Enabled (inherited from System.Web.UI.WebControls.WebControl)
EnableViewState (inherited from System.Web.UI.Control)
ErrorBoxCustomText If ErrorBoxType = Custom, this string is used in the pop-up dialogue for all errors.
ErrorBoxType This allows you to specify the way that DbCombo handles errors on the server.
Font (inherited from System.Web.UI.WebControls.WebControl)
ForceDownLevel This forces the control to operate in downlevel browser mode (html 3.2 only)
ForeColor (inherited from System.Web.UI.WebControls.WebControl)
Height (inherited from System.Web.UI.WebControls.WebControl)
HideAllSelectTags Setting this to true will hide all select tags when DbCombo opens. Select tags render on top of all objects in IE, sometimes causing the more button or status message to be obscured. All select tags on the page will be hidden while the DbCombo drop-down remains open. This provides far better performance than HideIntersectingSelectTags especially on large pages.
HideIntersectingSelectTags Setting this to true will hide all select tags that would intersect with DbCombo. Select tags render on top of all objects in IE, sometimes causing the more button or status message to be obscured. This function is disabled by default because the process of hiding the SELECT tags may reduce performance on complex pages.
ID (inherited from System.Web.UI.Control)
InvertArrow The Visual Studio.NET 2003 built-in browser fires the blur event of the DbCombo textbox when the image on the up-level search button is changed (from a down arrow to an up arrow). By default DbCombo will cancel the current query if this happens. If you specifically need DbCombo to work inside Visual Studio.NET 2003, set this to false. The arrow image on the button will not change while the results are open. Default is true.
Latency This is the number of miliseconds that DbCombo waits after the last keypress before making a query. The default of 300 ensures that a query is not fired on every keypress, when the user types several characters. A lower latency figures may be useful when server load is not important, and when internet latency is minimal (e.g. intranet useage). When Latency is set to -1, automatic searching on key presses is disabled.
MainSpanClass This is the class html attribute of the main span that encloses the whole control.
MainSpanStyle This is the style html attribute of the main span that encloses the whole control. You may want to set this to "display:block;" to draw the control in a block.
MaxLength This sets the maximum length of the text-box - if 0, then unlimited. Default is 0. Note: this only affects text input. If an item longer than the MaxLength is selected, it will be displayed in full.
MoreResultsBarClass This is the class html attribute of the 'more results' bar (the area that contains the 'more' button in up-level mode)
MoreResultsBarStyle This is the style html attribute of the 'more results' bar (the area that contains the 'more' button in up-level mode)
NamingContainer (inherited from System.Web.UI.Control)
NewVersionAvailable Used by the designer to persist whether a new version is available.
Page (inherited from System.Web.UI.Control)
Parent (inherited from System.Web.UI.Control)
RegistrationKey This is the registration key - If you do not have one, please go to www.dbcombo.net.
ReQueryDisabled If this is set to true, the control will not perform a re-query on load. If set to false, the control will perform a re-query if necessary. (Default: false).
ReQueryOnLoad This property determines if DbCombo will perform a re-query the next time it loads. It is initialy set to false, but if a query is attempted and the page is posted back, it will become true. Set to true initially to force a re-query. (default: false).
ReQueryRecords This is the number of records to return in a re-query. Defaults to the 10.
ReQueryText This is the re-query text. This must be properly set to initiate a re-querey on page load to occur.
This is the last peice of text that was actually typed by the user in the text box. It is usually smaller than the selected text and, when queried on, will usually return a larger number or items.
The text property, when queried, will usually only return one record. On postback DbCombo remembers what was last queried on, and uses this for a re-query. You can force a re-query on page load by entering a value for this property, and the ReQueryRecordCount property.
ResultsBackgroundSpanClass This is the class html attribute of the background of the UpLevel results
ResultsBackgroundSpanStyle This is the style html attribute of the background of the UpLevel results Default: "position:absolute;background-color:#ffffff;border:solid 1px #999999;".
ResultsInnerSpanClass This is the class html attribute of the background of the UpLevel results
ResultsInnerSpanStyle This is the style html attribute of the Inner of the UpLevel results Default: "border-bottom:solid 1px #999999;"
ResultsSelectBoxClass This is the class html attribute of the results list
ResultsSelectBoxStyle This is the style html attribute of the results list
ResultsSpanTweakX NOTE: The problem that caused this has been solved, so you should never need this. (I've left it in, just in case). The results span can be misaligned by an IE browser bug. If DbCombo is contained an element that has a border property set in a class definition, the width of the border will not be included in the offset of the results span. This will cause a misalignment. Tweak this variable until the edge of the results span is aligned with the edge of the text box. The first person providing a fix for this problem will receive a free copy of DbCombo.
ResultsSpanTweakY NOTE: The problem that caused this has been solved, so you should never need this. (I've left it in, just in case). The results span can be misaligned by an IE browser bug. If DbCombo is contained an element that has a border property set in a class definition, the height of the border will not be included in the offset of the results span. This will cause a misalignment. Tweak this variable until the top of the results span is aligned with the bottom of the text box. The first person providing a fix for this problem will receive a free copy of DbCombo.
SelectSingleItemOnEnter If there is only one item in the results and enter is pressed, this item will be selected if this property is set to true. (Default: true).
SelectSingleItemOnTab If there is only one item in the results and tab is pressed, this item will be selected if this property is set to true. (Default: true).
ServerAssembly This is the Assembly that the server will look in for the ServerMethod.
ServerDir If the DbComboServer.aspx file is not in the current directory, please specify the directory here e.g. If it is in the root directory, ServerDir should be set to "/". e.g. If it is in a directory called "support" that is in the root, ServerDir should be set to "/support/". e.g. If it is in a directory called "support" that is in the current directory, ServerDir should be set to "support/". Note: If you change this value, the design-time view may incorrectly render the up-level search button and dbcombo logo.
ServerMethod This is the name of the method that the server execute each time new results are needed. Default is DbComboMethod. It should have the following signature and attribute: [Cambro.Web.DbCombo.ResultsMethod(true)] public static object xxx(Cambro.Web.DbCombo.ServerMethodArgs args){}
ServerState This server state enables you to pass information about your application state securely from the server to the ServerMethod. You should ony use this property from code (not set it in the html).
ServerStateSecretString Setting this string enables you to authenticate the ServerState Hashtable as authentic.
ServerType This is the Type (namespace.class) that the server will look in for the ServerMethod.
ShowDbComboLink This hides or displays the DbCombo.net logo link.
ShowDownLevelHelpButton This hides or displays the DownLevel help button
ShowUpLevelHelpButton This hides or displays the UpLevel help button
ShowUpLevelSearchButton This hides or displays the up-level search button (this button is hidden by default). The up-level search button acts like a combo-box button, allowing a blank search to be performed.
Site (inherited from System.Web.UI.Control)
StatusMessageClass This is the class html attribute of the status messages
StatusMessageStyle This is the style html attribute of the status messages (Default "padding:5px;font-face:Arial, Verdana, Sans-serif;font-size:x-small;")
Style (inherited from System.Web.UI.WebControls.WebControl)
TabIndex This sets the tab index of the text box. The tab index of the up level search button is always set to -1. Tab indexes of other buttons follow in sequence from the main tabindex. Defaults to 1.
TabToNextFieldOnEnter When enter is pressed, DbCombo will simulate tab being pressed - e.g. skip to the next field. (Default: false).
TemplateSourceDirectory (inherited from System.Web.UI.Control)
Text This is the text of the currently selected value, provided by the DbComboText db field
TextAlt The text that appears in the ALT attribute of the textbox. This is useful for screen-readers.
TextBoxClass This is the class html attribute of the text box
TextBoxColumns This sets the size of the text-box (defaults to 30)
TextBoxStyle This is the style html attribute of the text box. Default: "border:solid 1px #999999;"
TextClearButton The text that appears in the 'Clear' button. (Default: "Clear")
TextDownLevelHelpBox The text that appears in the DownLevel help box (Default: "Enter a few letters of the item you\'re looking for, and press the \'Search\' button. A list will appear with possible values.") Note - use "\n" for a new line, and remember to escape certain characters - e.g. "'" must be written as "\'".
TextDownLevelSearchButton The text that appears in the down-level 'Search' button. (Default: "Search")
TextHelpButton The text that appears on the help button (Default: "?")
TextLoading The text that appears in the status message while DbCombo is loading more results. (Default: "Loading")
TextMoreButton The text that appears on the 'More' button (Default: "More...")
TextNoResults The text that appears when there are no results to display (Default: "No results")
TextSelectButton The text that appears on the 'Select' button (DownLevel only) (Default: "Select")
TextUpLevelHelpBox The text that appears in the UpLevel help box (Default: "This textbox will auto-complete as you type.\nEnter a few letters of the item you're looking for, and a pop-up will appear listing possible values.") Note - use "\n" for a new line, and remember to escape certain characters - e.g. "'" must be written as "\'".
TextUpLevelSearchButton This text appears in the up-level search button (this button is hidden by default). (Default: "\/")
ToolTip (inherited from System.Web.UI.WebControls.WebControl)
UniqueID (inherited from System.Web.UI.Control)
UpLevelButtonClass This is the class html attribute of all the up-level buttons in the control (Except the 'More...' button in the status panel.)
UpLevelButtonStyle This is the style html attribute of the up-level buttons in the control. (Except the 'More...' button in the status panel). Default = "border:solid 1px #999999;margin-left:-1;font-weight:bold;".
UpLevelMoreResultsButtonClass This is the class html attribute of the 'More...' button in the status panel
UpLevelMoreResultsButtonStyle This is the style html attribute of the 'More...' button in the status panel. Default: "border:solid 1px #999999;height:23px;". The hard-coded height of 23px fixes the button at the same height as the DbCombo logo and link. This ensures the button doesn't display smaller than the logo, as this situation doesn't look good. If you disable the link, you probably want to remove the hard-coded height here.
UpLevelSearchButtonType Determines whether the Up-Level search button displays as a string or a graphic.
ValidationProperty Validation can occur on either the text of value properties of DbCombo. (Default: ValidationProperties.Value)
ValidationPropertyValue Internally used during validation. Please ignore this property.
Value This is the currently selected value, provided by the DbComboValue db field
Visible (inherited from System.Web.UI.Control)
Width (inherited from System.Web.UI.WebControls.WebControl)

Public Instance Methods

ApplyStyle (inherited from WebControl)
bOverloaded.
CopyBaseAttributes (inherited from WebControl)
d
DataBind (inherited from Control)
Dispose (inherited from Control)
Equals (inherited from Object)
FindControl (inherited from Control)
g
GetHashCode (inherited from Object)
GetType (inherited from Object)
HasControls (inherited from Control)
MergeStyle (inherited from WebControl)
RenderBeginTag (inherited from WebControl)
RenderControl (inherited from Control)
RenderEndTag (inherited from WebControl)
Reset This method resets the DbCombo. DbCombo will not perform a requery after this method is called.
ResolveUrl (inherited from Control)
SetRenderMethodDelegate (inherited from Control)
ToString (inherited from Object)

Public Instance Events

GetDownLevelState This event is used to generate the state hashtable in downlevel browser mode. The event should take a DbCombo as a parameter, and return a Hashtable.
SelectedItemChanged This event fires on the server when the selected item has changed since the last postback.

Protected Instance Properties

ChildControlsCreated (inherited from System.Web.UI.Control)
Context (inherited from System.Web.UI.Control)
DownLevel This read-only bool shows whether the control should render in DownLevel mode
Events (inherited from System.Web.UI.Control)
HasChildViewState (inherited from System.Web.UI.Control)
IsTrackingViewState (inherited from System.Web.UI.Control)
TagKey (inherited from System.Web.UI.WebControls.WebControl)
TagName (inherited from System.Web.UI.WebControls.WebControl)
ViewState (inherited from System.Web.UI.Control)
ViewStateIgnoresCase (inherited from System.Web.UI.Control)

Protected Instance Methods

aOverloaded.
AddAttributesToRender (inherited from WebControl)
AddParsedSubObject (inherited from Control)
BuildProfileTree (inherited from Control)
ClearChildViewState (inherited from Control)
CreateChildControls Creates all chile controls
CreateControlCollection (inherited from Control)
CreateControlStyle (inherited from WebControl)
EnsureChildControls (inherited from Control)
Finalize (inherited from Object)
FindControl (inherited from Control)
IsLiteralContent (inherited from Control)
MapPathSecure (inherited from Control)
MemberwiseClone (inherited from Object)
OnBubbleEvent (inherited from Control)
OnDataBinding (inherited from Control)
OnInit (inherited from Control)
OnLoad (inherited from Control)
OnPreRender (inherited from Control)
OnUnload (inherited from Control)
RaiseBubbleEvent (inherited from Control)
Render (inherited from WebControl)
RenderChildren (inherited from Control)
RenderContents (inherited from WebControl)
TrackViewState (inherited from WebControl)

Protected Internal Instance Methods

AddedControl (inherited from Control)
RemovedControl (inherited from Control)

Explicit Interface Implementations

IParserAccessor.AddParsedSubObject (inherited from Control)
IAttributeAccessor.GetAttribute (inherited from WebControl)
IAttributeAccessor.SetAttribute (inherited from WebControl)

See Also

DbCombo Class | Cambro.Web.DbCombo Namespace