KoolGrid Class [PHP]

AjaxEnabledTop

bool AjaxEnabled

Enable ajax feature of KoolGrid.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AjaxEnabled = true;
?>

Supported from version: 1.0.0.0

AjaxHandlePageTop

string AjaxHandlePage

Get or set the service page which KoolGrid will send ajax request.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AjaxHandlePage = "grid_service_page.php";
?>

Supported from version: 1.0.0.0

AjaxLoadingImageTop

string AjaxLoadingImage

Get or set url of ajax loading image. This property only work when grid ajax is enablled.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AjaxLoadingImage = "KoolControls/KoolAjax/loading/5.gif";
?>

Supported from version: 1.0.0.0

AllowDeletingTop

bool AllowDeleting

Allow KoolGrid delete data.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowDeleting = true;
?>

Supported from version: 1.0.0.0

AllowEditingTop

bool AllowEditing

Allow KoolGrid edit and update data to datasource.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowEditing = true;
?>

Supported from version: 1.0.0.0

AllowFilteringTop

bool AllowFiltering

When true, all columns in grid will enable filtering feature.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowFiltering = true;
?>

Supported from version: 1.0.0.0

AllowGroupingTop

bool AllowGrouping

When true, all columns in grid will enable grouping feature.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowGrouping = true;
?>

Supported from version: 2.0.0.0

AllowHoveringTop

bool AllowHovering

Allow row highlighted when mouse is over.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowHovering = true;
?>

Supported from version: 1.0.0.0

AllowMultiSelectingTop

bool AllowMultiSelecting

Allow selecting more than one row.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowMultiSelecting = true;
?>

Supported from version: 1.0.0.0

AllowResizingTop

bool AllowResizing

When true, all resizable columns in grid will enable resizing feature.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowResizing = true;
?>

Supported from version: 1.0.0.0

AllowScrollingTop

bool AllowScrolling

Allow all tableview in grid scrollable.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowScrolling = true;
?>

Supported from version: 1.0.0.0

AllowSelectingTop

bool AllowSelecting

Allow row selected

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowSelecting = true;
?>

Supported from version: 1.0.0.0

AllowSortingTop

bool AllowSorting

When true, all sortable columns in grid will enable sorting feature.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AllowSorting = true;
?>

Supported from version: 1.0.0.0

AutoGenerateColumnsTop

bool AutoGenerateColumns

When true, grid will generate and add data-driven columns to all tableviews automatically.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateColumns = true;
?>

Supported from version: 1.0.0.0

AutoGenerateDeleteColumnTop

bool AutoGenerateDeleteColumn

When true, grid will add delete command column to all tableviews automatically.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateDeleteColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateEditColumnTop

bool AutoGenerateEditColumn

When true, grid will add edit command column to all tableviews automatically.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateEditColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateExpandColumnTop

bool AutoGenerateExpandColumn

When true, grid will add GridExpandDetailColumn to all tableviews automatically.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateExpandColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateRowSelectColumnTop

bool AutoGenerateRowSelectColumn

When true, grid will add GridRowSelectColumn to all tableviews automatically.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateRowSelectColumn = true;
?>

Supported from version: 1.0.0.0

CharSetTop

string CharSet

Get or set the charset.

Default value : "UTF-8"

Allowed values :

• "ISO-8859-1" : Western European, Latin-1
• "ISO-8859-15" : Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1(ISO-8859-1).
• "UTF-8" : ASCII compatible multi-byte 8-bit Unicode.
• "cp866" : DOS-specific Cyrillic charset. This charset is supported in 4.3.2.
• "cp1251" : Windows-specific Cyrillic charset. This charset is supported in 4.3.2.
• "cp1252" : Windows specific charset for Western European.
• "KOI8-R" : Russian. This charset is supported in 4.3.2.
• "BIG5" : Traditional Chinese, mainly used in Taiwan.
• "GB2312" : Simplified Chinese, national standard character set.
• "BIG5-HKSCS" : Big5 with Hong Kong extensions, Traditional Chinese.
• "Shift_JIS" : Japanese
• "EUC-JP" : Japanese

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->CharSet  = "ISO-8859-1"; //Western European, Latin-1
?>

Supported from version: 1.4.0.0

ClientSettingsTop

ClientSettings ClientSettings

Contain settings for client behaviours and messages.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ClientSettings->ClientMessage["DeleteConfirm"] = "Are you sure to delete the row?";
?>

Supported from version: 1.0.0.0

ColumnAlignTop

string ColumnAlign

Get or set alignment of column's text

Default value : "left"

Allowed values :

• "left" : Text in column aligns in left side
• "center" : Text in column aligns in center
• "right" : Text in column aligns in right side

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ColumnAlign  = "left";
?>

Supported from version: 1.0.0.0

ColumnValignTop

string ColumnValign

Get or set vertical alignment of column's text

Default value : "left"

Allowed values :

• "top" : Top alignment
• "middle" : Middle alignment
• "left" : Bottom alignment

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ColumnValign  = "top";
?>

Supported from version: 1.0.0.0

ColumnWrapTop

bool ColumnWrap

When true, all columns in grid will be in wrap mode. The long text will be broken in more than one line.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ColumnWrap = true;
?>

Supported from version: 1.0.0.0

DataSourceTop

DataSource DataSource

Get or set default datasource for all tableviews.

Show/Hide Code

<?php				
	$ds = new MySQLDataSource();
	$ds->SelectCommand = "select customerNumber,customerName from customers";
	$grid = new KoolGrid("grid");
	$grid->DataSource  = $ds;
?>

Supported from version: 1.0.0.0

DisableAutoGenerateDataFieldsTop

string DisableAutoGenerateDataFields

Get or set the list of field names that will not be generated column by KoolGrid. When you set AutoGenerateColumns to true, by default, KooLGrid will build columns for all available fieldnames. With this DisableAutoGenerateDataFields, you can choose the datafields that you do not want to build columns.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->AutoGenerateColumns  = true;
	$grid->DisableAutoGenerateDataFields  = "ID,customerNumber"; //Do not create columns for ID and customerNumber field.
?>

Supported from version: 1.0.0.0

EventHandlerTop

GridEventHandler EventHandler

Get or set the object to handle grid events.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnPageIndexChange($pager,$args)
		{
			//Catch the event when index changes
			echo $pager->PageIndex;
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.0.0.0

FilterOptionsTop

array FilterOptions

Get or set default filter options for all columns in grid.

Default value : array("No_Filter","Equal","Not_Equal","Greater_Than","Less_Than","Greater_Than_Or_Equal","Less_Than_Or_Equal","Contain","Not_Contain","Start_With","End_With");

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->FilterOptions  = array("No_Filter","Greater_Than","Less_Than");//Only show 3 options.
?>

Supported from version: 1.0.0.0

HeightTop

string Height

Get or set detfault height of all tableviews. The height can only be set with px value. This property is useful when you want grid with fixed height and do scrolling if data is longer than allowed space.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->Height  = "300px";
?>

Supported from version: 1.0.0.0

KeepGridRefreshTop

bool KeepGridRefresh

When true, grid will keep update up with new data.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->KeepGridRefresh = true;
?>

Supported from version: 4.0.0.0

KeepRowStateOnRefreshTop

bool KeepRowStateOnRefresh

Keep states of row on refresh such as: selected, sub-tables and so on.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->KeepRowStateOnRefresh = true;
?>

Supported from version: 3.0.0.0

KeepSelectedRecordsTop

bool KeepSelectedRecords

When true, grid will keep selected records persistent againts postback or callback.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->KeepSelectedRecords = true;
?>

Supported from version: 1.0.0.0

KeepViewStateInSessionTop

bool KeepViewStateInSession

Make grid persistent in session. When true, KoolGrid will use session to store its viewstate. This feature requires PHP Session to be turned on with session_start();

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->KeepViewStateInSession = true;
?>

Supported from version: 1.5.0.0

LocalizationTop

GridLocalization Localization

Contain settings for grid localization.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->Localization->Load("KoolControls/KoolGrid/localization/es.xml");
?>

Supported from version: 1.0.0.0

MasterTableTop

GridTableView MasterTable

Master table is the first and default GridTableView's instance of KoolGrid. This tableview is pre-created. You can access and change the settings of this master table.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->MasterTable->PageSize = 5;
?>

Supported from version: 1.0.0.0

PageSizeTop

int PageSize

Get or set the default page size for tableviews.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->PageSize  = 20;
?>

Supported from version: 1.0.0.0

RowAlternativeTop

bool RowAlternative

When true, it make grid show alternative color for each row.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->RowAlternative = true;
?>

Supported from version: 1.0.0.0

scriptFolderTop

string scriptFolder

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

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->scriptFolder = "KoolControls/KoolGrid";
?>

Supported from version: 1.0.0.0

ShowFooterTop

bool ShowFooter

When true, it make footer of all tableviews visible.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ShowFooter = true;
?>

Supported from version: 1.0.0.0

ShowHeaderTop

bool ShowHeader

When true, it make header of all tableviews visible.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ShowHeader = true;
?>

Supported from version: 1.0.0.0

ShowStatusTop

bool ShowStatus

When true, grid will show the status bar at bottom of grid.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ShowStatus = true;
?>

Supported from version: 1.0.0.0

SingleColumnSortingTop

bool SingleColumnSorting

When true, only one column is allowed sorting at a time.

Show/Hide Code

<?php				
	$grid = new KoolGrid();
	$grid->SingleColumnSorting = true;
?>

Supported from version: 1.0.0.0

StatusTop

StatusBar Status

KoolGrid status bar settings.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->ShowStatus = true;
	$grid->Status->DoneText = "Ready";
?>

Supported from version: 1.0.0.0

styleFolderTop

string styleFolder

Get or set the folder which KoolGrid will load css to render.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->styleFolder = "KoolControls/KoolGrid/styles/default";
?>

Supported from version: 1.0.0.0

TableLayoutTop

string TableLayout

Get or set layout of all tableviews.

Default value : "auto"

Allowed values :

• "auto" : Text in column aligns in left side
• "fixed" : Text in column aligns in center

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->TableLayout  = "fixed";
?>

Supported from version: 1.0.0.0

WidthTop

string Width

Get or set detfault width of all tableviews. The width can be set with px value of % value.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
	$grid->Width  = "900px";
?>

Supported from version: 1.0.0.0

RenderTop

void Render()

Render the KoolGrid

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterScriptTop

string RegisterScript()

Return html to register js library for KoolGrid.

Show/Hide Code

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

Supported from version: 1.0.0.0

RegisterCSSTop

string RegisterCSS()

Return html to register CSS for KoolGrid

Show/Hide Code

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

Supported from version: 1.0.0.0

RenderGridTop

string RenderGrid()

Return html content of KoolGrid body

Show/Hide Code

<body>
    <?php echo $grid->KoolGrid();?>
</body>

Supported from version: 1.0.0.0

StartupScriptTop

void StartupScript(string $script)

Regiser script to be at client from sever-side.

Show/Hide Code

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

Supported from version: 1.0.0.0

ProcessTop

void Process()

Process request and data before grid render.

Show/Hide Code

<?php
$grid = new KoolGrid("grid");
...
$grid->Process();
...
echo $grid->Render();
?>

Supported from version: 1.0.0.0

RefreshTop

void Refresh()

Force the grid to refresh. The data will be rebound.

Show/Hide Code

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnGridPreRender($grid,$args)
		{
			//$grid: The grid object.
			//$args: No data
 
			$grid->Refresh(); //Make grid refresh.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

GetInstanceMasterTableTop

GridTableView GetInstanceMasterTable()

Get the master table object after being processed.

Show/Hide Code

<?php
$grid = new KoolGrid("grid");
...
$grid->Process();
$mastertable = $grid->GetInstanceMasterTable();
?>

Supported from version: 1.0.0.0

RegisterClientEventTop

void RegisterClientEvent(string $event_name, string $event_handle_function_name)

Register client-side event.

Show/Hide Code

<?php
$grid = new KoolGrid("grid");
$grid->RegisterClientEvent("OnDetailTablesExpand","handle_onexpand");
$grid->Process();
echo $grid->Render();
?>	
 
<script type="text/javascript">
function handle_onexpand(sender,args)
{
	var _row = args["Row"];
	var _dataitem = _row.getDataItem();
	alert(_dataitem["customerNumber"]);
}
</script>

Supported from version: 1.0.0.0