constructor __construct [line 2524]
method AddItem [line 2853]
integer AddItem(
string
$item, [object
$object = null], [string
$itemkey = null])
|
|
Adds an item to the listbox
Use this method to add an item to the listbox, items can contain object pointers and also specify the key of the item in the items array.
Tags:
Overrides
CustomListControl::AddItem() (Adds an item to the list control.)
Parameters:
method Clear [line 2888]
This method clear listbox
Use this method to clear the items in the listbox and also clear the items selected.
Overrides
CustomListControl::Clear() (Deletes all of the items from the list control.)
method ClearSelection [line 2901]
Clears selected items in the listbox
Use this method when you want to reset the selection of items in the listbox. If multiselection is enabled, all selected items become unselected.
Overrides
CustomListControl::ClearSelection() (Removes the selection, leaving all items unselected.)
method defaultBorderStyle [line 3130]
void defaultBorderStyle(
)
|
|
method defaultDataField [line 3143]
method defaultDataSource [line 3167]
void defaultDataSource(
)
|
|
method defaultItemIndex [line 2836]
method defaultItems [line 3216]
method defaultMultiSelect [line 2983]
method defaultOnChange [line 3062]
method defaultOnClick [line 3088]
method defaultOnDblClick [line 3104]
void defaultOnDblClick(
)
|
|
method defaultOnSubmit [line 3117]
method defaultSize [line 3227]
method defaultSorted [line 3246]
method defaultTabOrder [line 3256]
method defaultTabStop [line 3265]
method dumpContents [line 2620]
method dumpFormItems [line 2738]
Overrides
Component::dumpFormItems() (Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components)
method dumpJavascript [line 2751]
method init [line 2581]
method loaded [line 2537]
method preinit [line 2544]
method readBorderStyle [line 3128]
Determines whether the listbox control has a single line border around the client area.
Use this property to specify which kind of border the control is going to use. Controls can have a single border (1 pixel wide) or none.
Tags:
method readCount [line 2797]
Returns the number of items stored in the object
Use this property to get the number of items the control stores, use addItem() to add new items to the control and clear() to remove all of them.
Overrides
CustomListControl::readCount() (Returns the number of items in the list.)
method readDataField [line 3141]
DataField is the fieldname to be attached to the control.
This property allows you to show/edit information from a table column using this control. To make it work, you must also assign the Datasource property, which specifies the dataset that contain the fieldname to work on
method readDataSource [line 3154]
DataSource property allows you to link this control to a dataset containing rows of data.
To make it work, you must also assign DataField property with the name of the column you want to use
method readItemIndex [line 2812]
Specify which item is selected on the list
Use this property to get/set the index of the item in the control that is selected. Use it at design-time to specify the default item selection and use it in run-time to get the user selection.
Overrides
CustomListControl::readItemIndex() (Returns the value of the ItemIndex property.)
method readItems [line 3190]
Contains the strings that appear in the list box.
Use this property to set the items that will be shown on the listbox where each item has a key and a value.
<?php
function ListBox1BeforeShow($sender, $params)
{
$items=array();
$items['key1']='value1';
$items['key2']='value2';
$this->ListBox1->Items=$items;
}
?>
method readMultiSelect [line 2965]
Determines whether the user can select more than one element at a time.
Use this property to allow the user to select several items at once.
<?php
function Button1Click($sender, $params)
{
echo "Number of selected items:".$this->ListBox1->SelCount."<br>";
$items=$this->ListBox1->Items;
while(list
($key, $val)=
each($items)) {
{
echo "Item selected: $key => $val<br>";
}
}
}
?>
Note: MultiSelect does not work if a data source is assigned.
Overridden in child classes as:
- ComboBox::readMultiSelect()
Overrides
CustomMultiSelectListControl::readMultiSelect() (Reads the value of the MultiSelect property.)
method readOnChange [line 3060]
Occurs when the user changed the item of the control.
This event is fired when the contents are committed and not while the value is changing. For example, on a text box, this event is not fired while the user is typing, but rather when the user commits the change by leaving the text box that has focus. In addition, this event is executed before the code specified by onblur when the control is also losing the focus.
Tags:
method readOnClick [line 3082]
Occurs when the user clicks the control.
Use the OnClick event handler to respond when the user clicks the control.
Usually OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:
The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.
The user presses Spacebar while a button or check box has focus.
The user presses Enter when the active form has a default button (specified by the Default property).
The user presses Esc when the active form has a cancel button (specified by the Cancel property).
Tags:
method readOnDblClick [line 3098]
Occurs when the user double-clicks the control.
Use this event to react when the user double click on the control, this event is usually fired after a set of other events, like mousedown and mouseup
Tags:
method readOnSubmit [line 3115]
Occurs when the form containing the control was submitted.
Use this event to write code that will get executed when the form is submitted and the control is about to update itself with the modifications the user has made on it.
method readSelCount [line 2925]
method readSelected [line 2996]
bool readSelected(
mixed
$index)
|
|
Checks if $index is selected.
Tags:
Parameters:
method readSize [line 3225]
Size of the listbox. Size defines the number of items that are shown without a need of scrolling.
If bigger than 1 most browsers will use Height instead. If Size equals 1 the listbox truns into a combobox.
method readSorted [line 3237]
Specifies whether the items in the control are arranged alphabetically.
If this property is set, items in the control will be sorted alphabetically according to the values of the items, not the keys.
method readTabOrder [line 3254]
TabOrder indicates in which order controls are access when using the Tab key.
The value of the TabOrder can be between 0 and 32767.
method readTabStop [line 3263]
Enable or disable the TabOrder property. The browser may still assign a TabOrder by itself internally. This cannot be controlled by HTML.
method SelectAll [line 2917]
Select all items in the control
Use this method to include all items in the control as selected. To make it work, MultiSelect property must be set to true.
Overrides
CustomListControl::SelectAll() (Selects all items or all text in the selected item.)
method writeBorderStyle [line 3129]
void writeBorderStyle(
$value)
|
|
Parameters:
method writeDataField [line 3142]
void writeDataField(
$value)
|
|
Parameters:
method writeDataSource [line 3158]
void writeDataSource(
$value)
|
|
If a data source is assigned multi-select cannot be used.
Parameters:
method writeItemIndex [line 2827]
method writeItems [line 3191]
method writeMultiSelect [line 2969]
method writeOnChange [line 3061]
void writeOnChange(
$value)
|
|
Parameters:
method writeOnClick [line 3087]
void writeOnClick(
mixed
$value)
|
|
Occurs when the user clicks the control.
Parameters:
method writeOnDblClick [line 3103]
void writeOnDblClick(
mixed
$value)
|
|
Occurs when the user double clicks the control.
Parameters:
method writeOnSubmit [line 3116]
void writeOnSubmit(
$value)
|
|
Parameters:
method writeSelected [line 3012]
void writeSelected(
mixed
$index, bool
$value)
|
|
Select or unselect a specific item.
Parameters:
method writeSize [line 3226]
method writeSorted [line 3238]
void writeSorted(
$value)
|
|
Parameters:
method writeTabOrder [line 3255]
void writeTabOrder(
$value)
|
|
Parameters:
method writeTabStop [line 3264]
void writeTabStop(
$value)
|
|
Parameters:
