KoolListBox Class [PHP]

AllowHoverTop

bool AllowHover

Get or set whether item hovering is allowed.

Default value : true

Show/Hide Code

<?php
...
	$listbox->AllowHover=false; 
...
?>

Supported from version: 1.0.0.0

AllowMultiSelectTop

bool AllowMultiSelect

Get or set whether item multi-selecting is allowed.

Default value : false

Show/Hide Code

<?php
...
	$listbox->AllowMultiSelect=true; 
...
?>

Supported from version: 1.0.0.0

AllowReorderTop

bool AllowReorder

Get or set whether item ordering is allowed. By setting this to true, user will be able to move item up and down to reoder.

Show/Hide Code

<?php
...
	$listbox->AllowReorder=true; 
...
?>

Supported from version: 1.0.0.0

AllowSelectTop

bool AllowSelect

Get or set whether item selecting is allowed.

Default value : true

Show/Hide Code

<?php
...
	$listbox->AllowSelect=true; 
...
?>

Supported from version: 1.0.0.0

AllowTransferTop

bool AllowTransfer

Get or set whether item transferring is allowed.

Show/Hide Code

<?php
...
	$listbox->AllowTransfer=true; 
...
?>

Supported from version: 1.0.0.0

AllowTransferOnDoubleClickTop

bool AllowTransferOnDoubleClick

Get or set whether item transferring is allowed when user do double clicks.

Show/Hide Code

<?php
...
	$listbox->AllowTransferOnDoubleClick=true; 
...
?>

Supported from version: 1.0.0.0

AutoPostBackOnDeleteTop

bool AutoPostBackOnDelete

Get or set whether listbox will do postback after items are deleted.

Show/Hide Code

<?php
...
	$listbox->AutoPostBackOnDelete=true; 
...
?>

Supported from version: 1.0.0.0

AutoPostBackOnReorderTop

bool AutoPostBackOnReorder

Get or set whether listbox will do postback after items are reordered.

Show/Hide Code

<?php
...
	$listbox->AutoPostBackOnReorder=true; 
...
?>

Supported from version: 1.0.0.0

AutoPostBackOnTransferTop

bool AutoPostBackOnTransfer

Get or set whether listbox will do postback after items are tranferred.

Show/Hide Code

<?php
...
	$listbox->AutoPostBackOnTransfer=true; 
...
?>

Supported from version: 1.0.0.0

CheckedItemsTop

string CheckedItems

Contains the list of checked items. This list should be accessed after listbox is initiated.

Show/Hide Code

<?php
...
	$listbox->UseCheckBoxes = true;
	$listbox->Init();
 
	for($i=0;$i<count($listbox->CheckedItems);$i++)
	{
		echo $listbox->CheckedItems[$i]->Text;
	}	
...
?>

Supported from version: 1.0.0.0

ClientEventsTop

array ClientEvents

Get or set the client-side event.

Show/Hide Code

<?php
...
	$listbox->ClientEvents["OnSelect"]="Handle_OnSelect";
...
?>

Supported from version: 1.0.0.0

EventHandlerTop

array EventHandler

Get or set the client-side event.

Show/Hide Code

<?php
...
	class MyOwnEventHandler extends ListBoxEventHandler
	{
		function OnBeforeReorder($sender,$args)
		{
			return true;
		}
		function OnReorder($sender,$args)
		{
 
		}
 
		function OnBeforeTransferIn($sender,$args)
		{
			return true;
		}
		function OnTransferIn($sender,$args)
		{
 
		}
 
		function OnBeforeDelete($sender,$args)
		{
			return true;
		}
		function OnDelete($sender,$args)
		{
 
		}
 
		function OnBeforeItemCheck($sender,$args)
		{
			return true;
		}
		function OnItemCheck($sender,$args)
		{
 
		}
	}
	$listbox->EventHandler = new MyOwnEventHandler();
...
?>

Supported from version: 1.0.0.0

HeightTop

string Height

Get or set the height of KoolListBox.

Show/Hide Code

<?php
...
	$listbox->Height="300px";
...
?>

Supported from version: 1.0.0.0

idTop

string id

Get or set the id for KoolListBox. This id will be use as variable name of KoolListBox at client-side.

Show/Hide Code

<?php		
	$listbox->id="listbox";//We usuall use the same id name with server-side for better reference. 
?>

Supported from version: 1.0.0.0

ItemsTop

string Items

Contains the list of all items.

Show/Hide Code

<?php
...
	$listbox->Init();
 
	for($i=0;$i<count($listbox->Items);$i++)
	{
		echo $listbox->Items[$i]->Text;
	}	
...
?>

Supported from version: 1.0.0.0

ItemTemplateTop

string ItemTemplate

Get or set the template for listbox item. The data key is written in fomr {datakey} and will be replaced with text when ready.

Show/Hide Code

<?php
...
	$listbox->ItemTemplate="<div style='my_own_style_class'>{Text}</div>";
...
?>

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

Get or set the path to folder which contains KoolListBox script.

Show/Hide Code

<?php				
	$listbox = new KoolListBox("listbox");
	$listbox->scriptFolder = "KoolControls/KoolListBox";
?>

Supported from version: 1.0.0.0

SelectedItemsTop

string SelectedItems

Contains the list of selected items. This list should be accessed after listbox is initiated.

Show/Hide Code

<?php
...
	$listbox->Init();
 
	for($i=0;$i<count($listbox->SelectedItems);$i++)
	{
		echo $listbox->SelectedItems[$i]->Text;
	}	
...
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set folder which contain css style for KoolListBox

Show/Hide Code

<?php 
	$listbox->styleFolder="default";//Use the "default" style
	//Other styles include "black", "forest", "office2007", "office2010black", "office2010blue", "office2010silver", "outlook", "sunset", "vista", "web20", "windows7"
?>

Supported from version: 1.0.0.0

TransferModeTop

string TransferMode

Get or set whether item will be copied or moved when transferred.

Default value : "Move"

Allowed values :

• "Move" : Move item
• "Copy" : Copy item

Show/Hide Code

<?php
...
	$listbox->TransferMode="Copy";
...
?>

Supported from version: 1.0.0.0

TransferToIdTop

string TransferToId

Get or set the id of destination listbox.

Default value : "Move"

Show/Hide Code

<?php
...
	$listbox->TransferToId="second_listbox";
...
?>

Supported from version: 1.0.0.0

UpdatePanelTop

string UpdatePanel

Set the id of updatepanel that contains this listbox. By setting this property, listbox will do ajax call back instead of posting back when reorder or transfer occurs.

Show/Hide Code

<?php
...
	$listbox->UpdatePanel="my_updatepanel_id";
...
?>

Supported from version: 1.0.0.0

UseCheckBoxesTop

bool UseCheckBoxes

Get or set whether checkbox is used.

Show/Hide Code

<?php
...
	$listbox->UseCheckBoxes=true; 
...
?>

Supported from version: 1.0.0.0

WidthTop

string Width

Get or set the width of KoolListBox.

Show/Hide Code

<?php
...
	$listbox->Width="300px";
...
?>

Supported from version: 1.0.0.0

AddItemTop

KoolListBoxItem AddItem(ListBoxItem $item)

Add listbox item. The function returns the item object.

Show/Hide Code

<?php
...
	$item = $listbox->Add(new ListBoxItem("Canada","can"));//Insert the text="Canada" and Value="can"
	$item->Selected = true;
...
?>

Supported from version: 1.0.0.0

ClearAllTop

 ClearAll()

Clear all items.

Show/Hide Code

<?php
...
	$listbox->Init();
 
	$listbox->ClearAll();
 
	//Insert new items
	$listbox->AddItem(new ListBoxItem("Item1"));
	$listbox->AddItem(new ListBoxItem("Item2"));		
	$listbox->AddItem(new ListBoxItem("Item3"));		
...
?>

Supported from version: 1.0.0.0

InitTop

 Init()

Initiate listbox. This function should be called before listbox is rendered.

Show/Hide Code

<?php
...
	$listbox->Init();
 
	echo $listbox->Render();
...
?>

Supported from version: 1.0.0.0

RenderTop

void Render()

Render the KoolListBox

Show/Hide Code

<body>
	<?php echo 	$listbox->Render(); ?>
</body>

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolListBox.

Show/Hide Code

<head>
    <?php echo $listbox->RegisterScript(); ?>
</head>

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolListBox

Show/Hide Code

<head>
    <?php echo  $listbox->RegisterCSS();?>
</head>

Supported from version: 1.0.0.0

RenderListBoxTop

string RenderListBox()

Return html content of KoolListBox body

Show/Hide Code

<body>
    <?php echo $listbox->RenderListBox();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

string StartupScript()

Return js code to inititate KoolListBox

Show/Hide Code

<script type="text/javascript">
    <?php echo $listbox->StartupScript();?>
</script>

Supported from version: 1.0.0.0