WebCombo Properties

ClassName	Description The ClassName of WebCombo. ValueType string Default Value -
Version	Description The Version of WebCombo. ValueType string Default Value -
MajorVersion	Description The Major Version of WebCombo. ValueType string Default Value -
RequiredFrameworkVersion	Description The minimum required WebUI.NET framework version in order to run WebCombo. ValueType string Default Value -
Text	Description The selected text of the WebCombo. ValueType string Default Value -
Value	Description The selected value of the WebCombo. ValueType string Default Value -
TextBoxLength	Description The size of the TextBox control. ValueType integer Default Value -
DropDownRows	Description The number of initial records retrieved by the WebCombo control. ValueType integer Default Value -
AutoLoad	Description Specifies whether the control should automatically make initial request on page load. ValueType boolean Default Value -
ShowErrorMessages	Description Specifies whether to show Error Messages. ValueType boolean Default Value -
Latency	Description Specifies the wait time after last key press in milliseconds before the control make data request. ValueType integer Default Value -
AllowAutoPostback	Description Specifies whether Postback will be automatically invoked when selected index is changed. ValueType boolean Default Value -
DataValueField	Description Gets or sets the field used as the value in WebCombo control. ValueType string Default Value -
DataTextField	Description Gets or sets the data field used to display the text in WebCombo control. ValueType string Default Value -
LayoutSettings	Description Gets the LayoutSettings object which is the central object that contain all the behaviors and styles for the whole WebCombo control. ValueType object (LayoutSettings) Default Value -
LinkSettings	Description Gets or Sets the LinkSettings object. ValueType object (LinkSettings) Default Value -
MultipleSelectionSettings	Description Gets or Sets the MultipleSelectionSettings object. ValueType object (MultipleSelectionSettings) Default Value -
AdditionalFiltersText	Description Gets or sets the additional filter text for WebCombo control. ValueType string Default Value -
AllowAutoQueryHandler	Description Specifies whether to allow WebCombo to automatically handle query request. ValueType boolean Default Value -
Columns	Description Gets the WebComboColumn object. ValueType object (WebComboColumn) Default Value -
AdditionalSearchFields	Description Gets or sets the additional data field used to match rows against user input. ValueType string Default Value -
AllowWildCardSearch	Description Specifies whether to allow wild card searching / fuzzy logic searching. ValueType boolean Default Value -
MinCharsToRequest	Description Gets or sets the minimum length of input character for requesting data retrieval. ValueType integer Default Value -
Name	Description Gets the WebCombo instance name. ValueType string Default Value -
LastAction	Description Gets the last action performed by the WebCombo. ValueType string Default Value -
TotalRetrievedRows	Description Gets the number of rows which have been retrieved by the WebCombo. ValueType integer Default Value -
TotalRows	Description Gets the number of all rows which should be loaded by WebCombo. ValueType integer Default Value -
FlyPostBackSettings	Description Gets the OnTheFly�?� PostBack settings utilized by WebCombo. ValueType object (FlyPostBack) Default Value -
ResultBoxShown	Description Determines whether the result box should be shown. ValueType boolean Default Value -
IsDirty	Description Determines whether WebCombo has been modified. ValueType boolean Default Value -
IsInProgress	Description Determines whether WebCombo is currently processing data. ValueType boolean Default Value -
IsMoreRequest	Description Determines whether WebCombo needs to perform more request. ValueType boolean Default Value -
NeedClearList	Description Determines NeedClearList value. ValueType boolean Default Value -
LastSelectedIndex	Description Gets the last selected index of last selected record. ValueType integer Default Value -
SelectedIndex	Description Gets the currently selected index of WebCombo record. ValueType integer Default Value -
ForceDropDown	Description Determines whether the dropdown should be displayed. ValueType boolean Default Value -
IsDataBound	Description Determines whether the combo is in unbound mode or bound mode. ValueType boolean Default Value -
UnboundDataInitialized	Description Gets the unbound data initialization. ValueType object Default Value -
InsertAtTop	Description Determines whether the previously added record should be inserted at the end of the collection or at the beginning of the collection. ValueType boolean Default Value -
LastError	Description Gets the last error message during WebCombo processing mode. ValueType string Default Value -
FoundPerfectMatch	Description Determines whether WebCombo successfully finds a perfect match record. ValueType boolean Default Value -
FastPostBack	Description Determines whether Fast PostBack should be performed. ValueType boolean Default Value -
SensitiveSearch	Description Determines whether case sensitive search mode should be performed. ValueType boolean Default Value -
TextObj	Description Gets the Text object of the WebCombo. ValueType object (INPUT HTML element) Default Value -
SearchObj	Description Gets the Search object of the WebCombo. ValueType object (SPAN HTML element) Default Value -

WebCombo Methods

SendCustomRequest	Description Invoke WebCombo's OnTheFly PostBack in order to perform custom actions from the client side and then respond the requested action at the server side Parameters - Remarks SendCustomRequest method will invoke server side InitializePostBack event. Return Value void Samples Invokes OnTheFly PostBack event. function InvokeSendCustomRequest() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Invoke WebCombo's OnTheFly PostBack combo.SendCustomRequest(); return true; }
IsValueInRange	Description Determines whether the Value is in the list. Parameters - Remarks This method is quite useful in bound mode. Return Value boolean Samples function CustomFunction() { var combo = ISGetObject("WebCombo1"); alert( combo.IsValueInRange()); return true; }
GetImagesFolder	Description Gets the image directory of the WebCombo which has been defined using ImagesDirectory value. Parameters - Remarks - Return Value string Samples Obtain WebCombo's ImagesDirectory property value. function GetImagesFolder() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Obtain WebCombo's ImagesDirectory property value alert(combo.GetImagesFolder()); return true; }
ShowDropDown	Description Instructs WebCombo to show its DropDown symbol. Parameters - Remarks - Return Value void Samples Force WebCombo to show its DropDown symbol. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Force WebCombo to show its DropDown symbol combo.ShowDropDown(); return true; }
HideDropDown	Description Instructs WebCombo not to show its DropDown symbol. Parameters - Remarks - Return Value void Samples Force WebCombo not to show its DropDown symbol. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Force WebCombo not to show its DropDown symbol combo.HideDropDown(); return true; }
SetSelectedIndex	Description Highlight a record in the WebCombo's records collection by inserting the record's index. Parameters i ( integer ) The index of the record (starting from zero) Remarks - Return Value void Samples Select the second record of the WebCombo's records. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Select the second record of the WebCombo's records combo.SetSelectedIndex(1); return true; }
SetSelectedRowByValue	Description Highlight a record in the WebCombo records collection by matching a string value. Parameters v ( string ) The value of the WebCombo's record in order to be looked up. Remarks - Return Value void Samples Highlight the record with key value = "ALFKI". function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Highlight the record with key value = "ALFKI" combo.SetSelectedRowByValue("ALFKI"); return true; }
SetText	Description Configure the WebCombo text. Parameters s ( string ) The WebCombo's Text (DataTextField) which is inserted. sameValue ( boolean ) Determines whether the value of the correspond's text is the same with the text. false Remarks Remember to invoke LoadValue() method after using SetText() method, in order to instruct WebCombo to fetch the Value of the correspond inserted Text from the server. The LoadValue() method is required for Bound mode, because when a new text is set, the WebCombo doesn't have the related Value in client side since the data has not been loaded. This method is not required for Unbound mode. Return Value void Samples Configure the WebCombo's text. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Configure the WebCombo's text combo.SetText("Condiments"); // required only for Bound mode, instructs the WebCombo // to fetch the Value from server. // this method is required for Bound mode because when // a new text is set, // the WebCombo doesn't have the related Value in // client side since the data has not been loaded. // this method is not required for Unbound mode. combo.LoadValue(); return true; }
LoadValue	Description Instructs the WebCombo to fetch the Value from server Parameters useSync ( boolean ) Determines whether the LoadValue method is performing the function synchronously or asynchronously. If the synchronous mode is used by inserting true value, then developers can obtain the direct value after the LoadValue method is invoked. false Remarks Remember to invoke LoadValue() method after using SetText() method, in order to instruct WebCombo to fetch the Value of the correspond inserted Text from the server. The LoadValue() method is required for Bound mode, because when a new text is set, the WebCombo doesn't have the related Value in client side since the data has not been loaded. This method is not required for Unbound mode. Return Value void Samples Instructs the WebCombo to fetch the Value from server. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Configure the WebCombo's text combo.SetText("Condiments"); // required only for Bound mode, instructs the WebCombo // to fetch the Value from server. // this method is required for Bound mode because when // a new text is set, // the WebCombo doesn't have the related Value in // client side since the data has not been loaded. // this method is not required for Unbound mode. combo.LoadValue(); return true; }
SetValue	Description Configure the WebCombo's Value. Parameters v ( string ) The Value of the WebCombo to be inserted. Remarks - Return Value void Samples Configure the WebCombo's Value function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Configure the WebCombo's value combo.SetValue("ALFKI"); return true; }
GetTextBoxValue	Description Obtains the value inside the TextBox portion of the WebCombo. The value inside the TextBox portion is NOT the WebCombo's Text (DataTextField). Parameters - Remarks - Return Value string Samples Gets the value inside the TextBox portion of the WebCombo. The value inside the TextBox portion is NOT the WebCombo's Text (DataTextField). function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Obtains the value inside the TextBox // portion of the WebCombo combo.GetTextBoxValue(); return true; }
SetTextBoxValue	Description Sets the value inside the TextBox portion of the WebCombo. The value inside the TextBox portion is NOT the WebCombo's Text (DataTextField). Parameters v ( string ) The string or value that needs to be displayed in the TextBox portion of WebCombo. Remarks - Return Value void Samples Sets the value inside the TextBox portion of the WebCombo. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Sets the value inside the TextBox // portion of the WebCombo combo.SetTextBoxValue("Please select the CustomerID"); return true; }
ClearSelection	Description Instructs WebCombo to clear any currently selected item. Parameters - Remarks - Return Value void Samples Instructs WebCombo to clear any currently selected item. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Instructs WebCombo to clear any currently selected item combo.ClearSelection(); return true; }
NewRow	Description Instantiates a new row complete with its cells definitions. Parameters v ( string ) The KeyValue of the inserted string. Remarks - Return Value object (WebComboRow) Samples Instantiates a new row with NEWCUST as the KeyValue, containing cells with empty value. function CustomFunction() { // obtain WebCombo object var combo = ISGetObject("WebCombo1"); // get the WebCombo4's rows for addition var rows = combo.GetRows(); // instantiate new row with NEWCUST as the KeyValue, containing cells with empty value var newRow = combo.NewRow("NEWCUST"); // get the cells of the new row for value assignment var cells = newRow.GetCells(); // write codes in the same way as in server-side object model, with similar object hierarchy. cells.GetNamedItem("ContactName").Text = "New Customer"; // assign value to Address Cell cells.GetNamedItem("Address").Text = "New Address"; cells.GetNamedItem("CustomerID").Text = "NEWCUST"; //add the newRow to the rows collection rows.Add(newRow); // instruct WebCombo to update the user interface accordingly to the changes in Rows object. combo.UpdateUI(); alert("NEWCUST row added!"); return true; }
GetSelectedValueItem	Description Gets currently selected ValueItem. Parameters - Remarks - Return Value object (WebComboValueItem) Samples Get currently selected ValueItem function CustomFunction() { var combo = ISGetObject("WebCombo1"); alert(combo.GetSelectedValueItem()); return true; }
ClearSelectedValueItem	Description Clear any currently selected ValueItem. Parameters - Remarks - Return Value void Samples Clear currently selected ValueItem function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.ClearSelectedValueItem(); return true; }
GetRows	Description Gets WebComboRow object collection. Parameters - Remarks - Return Value object (WebComboRow) collection Samples Populate Row objects on demand function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // populate Row objects on demand in order to access it var rows = combo.GetRows(); var count = rows.length; if (count > 20) count = 20; for (var i=0; i<count; i++) s += "Row " + i + " : " + "Value=" + rows[i].Value + " "; alert("WebCombo1 has " + rows.length + " row(s). The rows are: " + s + " ..."); return true; }
GetRowsCount	Description Gets the number of loaded rows. Parameters - Remarks - Return Value integer Samples Gets the number of loaded rows. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Show the number of loaded rows alert(combo.GetRowsCount()); return true; }
GetRow	Description Gets the WebComboRow object from a certain index. Parameters v ( integer ) The row index of the intended row (starting from zero). Remarks - Return Value object (WebComboRow) Samples Gets the first row. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // get WebComboRow at position 0 var row0 = combo.GetRow(0); if (row0 != null) { // access to WebComboCell at position 0 of the row var cell0 = row0.GetCell(0); var cellElement = cell0.GetElement(); if (cellElement) { // change the html element's fore color style to Red cellElement.style.color = "red"; alert("HTML Element of WebCombo2's Row 0, Cell0 found. The fore color has been changed to Red."); combo.SetFocus(); combo.ShowDropDown(); } } }
GetSelectedRow	Description Gets the WebComboRow object of the currently selected row. Parameters - Remarks - Return Value object (WebComboRow) Samples Gets the selected WebComboRow object. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Gets the selected WebComboRow object var row0 = combo.GetSelectedRow(); return true; }
Disable	Description Disable the WebCombo Parameters - Remarks - Return Value void Samples Disables WebCombo. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Disable WebCombo combo.Disable(); return true; }
Enable	Description Enable the WebCombo. Parameters - Remarks - Return Value void Samples Enables WebCombo. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Enable WebCombo combo.Enable(); return true; }
SetFocus	Description Give the current WebCombo's a focus. Parameters Remarks - Return Value void Samples Gives focus to WebCombo1. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Give focus to WebCombo1 combo.SetFocus(); return true; }
Show	Description Show the WebCombo. Parameters - Remarks - Return Value void Samples Shows the WebCombo1. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Show the WebCombo1 combo.Show(); return true; }
Hide	Description Hides the WebCombo. Parameters Remarks - Return Value void Samples Hides the WebCombo1. function CustomFunction() { // Obtain WebCombo object var combo = ISGetObject("WebCombo1"); // Hide the WebCombo1 combo.Hide(); return true; }
AddItem	Description Add an item to the WebCombo's records collection. Parameters text ( string ) The text (DataTextField) part of the new data. value ( string ) The value (DataValueField) of the new data. columndata ( object (Array) ) The array containing the all the data in each columns. Remarks - Return Value void Samples Add an item to the WebCombo. function DoAdd() { var combo = ISGetObject("WebCombo1"); var tblNew = document.getElementById("tblNew"); combo.AddItem(document.forms[0].txtContactName.value, document.forms[0].txtCustID.value, new Array(document.forms[0].txtContactName.value, document.forms[0].txtContactTitle.value, document.forms[0].txtCompanyName.value) ); tblNew.style.display = "none"; }
UpdateUI	Description Instructs WebCombo to update the user interface accordingly to the changes in Rows object. Parameters - Remarks - Return Value void Samples Instructs WebCombo to update the user interface accordingly to the changes in Rows object. function CustomFunction() { // get the WebCombo4's rows for addition var rows = wc4.GetRows(); // instantiate new row with NEWCUST as the KeyValue, containing cells with empty value var newRow = wc4.NewRow("NEWCUST"); var cells = newRow.GetCells(); // write codes in the same way as in server-side object model, with similar object hierarchy. cells.GetNamedItem("ContactName").Text = "New Customer"; // assign value to Address Cell cells.GetNamedItem("Address").Text = "New Address"; cells.GetNamedItem("CustomerID").Text = "NEWCUST"; //add the newRow to the rows collection rows.Add(newRow); // instruct WebCombo to update the user interface accordingly to the changes in Rows object. wc4.UpdateUI(); alert("NEWCUST row added!"); }
GetLastAction	Description Gets the last action performed by WebCombo. Parameters - Remarks - Return Value string Samples Gets the last action performed by WebCombo. function CustomFunction() { var combo = ISGetObject("WebGrid1"); alert(combo.GetLastAction()); return true; }
UpdateState	Description Instructs WebCombo to update its current state. Parameters - Remarks - Return Value void Samples Utilizing UpdateState method function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.UpdateState(); return true; }
DoResize	Description Instructs WebCombo to resize its current layout because of the changes in style. Parameters - Remarks - Return Value void Samples Utilizing DoResize method. function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.DoResize(); return true; }
UnhighlightRow	Description Unhighlights currently highlighted row. Parameters row ( object (WebComboRow) ) The WebComboRow type of the row Remarks - Return Value void Samples Unhighlight the 13th row function CustomFunction() { var combo = ISGetObject("WebCombo1"); // get all rows var rows = combo.GetRows(); // get the 13th row var row = rows[12]; // highlight the 13th row row.Select(); // unhighlight the 13th row combo.UnhighlightRow(row); return true; }
InitializeUnboundMode	Description Prepare the WebCombo in order to utilize UnBound mode Parameters - Remarks - Return Value void Samples Using InitializeUnboundMode method function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.InitializeUnboundMode(); return true; }
SetAdditionalFilters	Description Sets the additional filter constraints in order to filter the contents of the WebCombo Parameters s ( string ) The definition of the filter constraints Remarks - Return Value void Samples Configure additional filter in order to filter the contents of the WebCombo3 function OnCheckBoxClick() { var chkBox = document.getElementById("CheckBox1"); var combo2 = ISGetObject("WebCombo2"); var combo3 = ISGetObject("WebCombo3"); if (chkBox.checked) { if (combo2.Value == null \|\| combo2.Value == "") { alert("Please select a category !"); chkBox.checked = false; return; } else { combo3.SetAdditionalFilters("[CategoryID] = " + combo2.Value); } } else { combo3.ClearAdditionalFilters(); } }
ClearAdditionalFilters	Description Clears any additional filters text which has been defined before using SetAdditionalFilters method Parameters - Remarks - Return Value void Samples Clear any additional filters defined on the WebCombo3 function OnCheckBoxClick() { var chkBox = document.getElementById("CheckBox1"); var combo2 = ISGetObject("WebCombo2"); var combo3 = ISGetObject("WebCombo3"); if (chkBox.checked) { if (combo2.Value == null \|\| combo2.Value == "") { alert("Please select a category !"); chkBox.checked = false; return; } else { combo3.SetAdditionalFilters("[CategoryID] = " + combo2.Value); } } else { combo3.ClearAdditionalFilters(); } }
SetMultipleValues	Description Sets the MultipleValues Parameters text ( string ) The text (DataTextField) part value ( string ) The value (DataValueField) part Remarks - Return Value void Samples SetMultipleValues sample function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.SetMultipleValues("Anne", "9"); return true; }
GetMultipleValues	Description Gets MultipleSelection values Parameters - Remarks - Return Value string Samples GetMultipleValues sample function GetValues() { var combo = ISGetObject("WebCombo1"); var values = combo.GetMultipleValues(); if (values == null \|\| values.length == 0) { alert("There are no values in WebCombo1!"); } else { var s = ""; for(var i=0; i<values.length; i++) { var valueItem = values[i]; s += "Text='" + valueItem.Text + "'; Value='" + valueItem.Value + "'" + " "; } alert("Values entered in WebCombo1 are: " + s); } }
GetMultipleValuesText	Description Gets MultipleValues text Parameters - Remarks - Return Value string Samples GetMultipleValuesText sample function CustomFunction() { var combo = ISGetObject("WebCombo1"); alert(combo.GetMultipleValuesText()); return true; }
GetMultipleValuesValue	Description Gets MultipleValues value Parameters - Remarks - Return Value string Samples GetMultipleValuesValue sample function CustomFunction() { var combo = ISGetObject("WebCombo1"); alert(combo.GetMultipleValuesValue()); return true; }
RefreshValueItems	Description Refresh the ValueItems list with the current one. Parameters - Remarks - Return Value void Samples function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.RefreshValueItems(); return true; }
RefreshTextByValueItems	Description Refresh the correspondent text of the textbox portion of the WebCombo given latest ValueItems. Parameters - Remarks - Return Value void Samples function CustomFunction() { var combo = ISGetObject("WebCombo1"); combo.RefreshTextByValueItems(); return true; }

Intersoft WebCombo Documentation
WebCombo
Send comments on this topic.