KoolGrid

GridEventHandler Class [PHP]

	Methods	Description
	OnBeforeDetailTablesExpand	Occurring before a grid row expands its detail tables.
	OnDetailTablesExpand	Occurring after a grid row expands its detail tables.
	OnBeforeDetailTablesCollapse	Occurring before a grid row collapses its detail tables.
	OnDetailTablesCollapse	Occurring after a grid row collapses its detail tables.
	OnBeforeRowStartEdit	Occurring before a grid row is in edit mode.
	OnRowStartEdit	Occurring after a grid row is in edit mode.
	OnBeforeRowCancelEdit	Occurring before a grid row cancels editing.
	OnRowCancelEdit	Occurring after a grid row cancels editing.
	OnBeforeRowDelete	Occurring before a grid row is deleted.
	OnRowDelete	Occurring after a grid row is deleted.
	OnBeforeColumnSort	Occurring before a grid column is sorted.
	OnColumnSort	Occurring after a grid column is sorted.
	OnBeforeColumnGroup	Occurring before a grid column is grouped.
	OnColumnGroup	Occurring after a grid column is grouped.
	OnBeforeColumnFilter	Occurring before a grid column is filtered.
	OnColumnFilter	Occurring after a grid column is filtered.
	OnBeforePageIndexChange	Occurring before a grid pager changes its page index.
	OnPageIndexChange	Occurring after a grid pager changes its page index.
	OnBeforePageSizeChange	Occurring before a grid pager changes its page size.
	OnPageSizeChange	Occurring after a grid pager changes its page size.
	OnBeforeRowConfirmEdit	Occurring before a grid row confirms edit.
	OnRowConfirmEdit	Occurring after a grid row confirms edit.
	OnBeforeConfirmInsert	Occurring before tableview adds a new row.
	OnConfirmInsert	Occurring after tableview adds a new row.
	OnBeforeStartInsert	Occurring before tableview starts inserting a new row.
	OnStartInsert	Occurring after tableview starts inserting a new row.
	OnBeforeCancelInsert	Occurring before tableview cancels inserting.
	OnCancelInsert	Occurring after tableview cancels inserting.
	OnTableViewPreRender	Occurring before the tableview render.
	OnRowPreRender	Occurring before a row renders.
	OnGridPreRender	Occurring before the grid renders.

OnBeforeDetailTablesExpandTop

bool OnBeforeDetailTablesExpand(GridRow $row, array $args)

Occurring before a grid row expands its detail tables. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeDetailTablesExpand($row,$args)
		{
			//$row: The grid row object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnDetailTablesExpandTop

void OnDetailTablesExpand(GridRow $row, array $args)

Occurring after a grid row expands its detail tables.

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

Supported from version: 1.6.0.0

OnBeforeDetailTablesCollapseTop

bool OnBeforeDetailTablesCollapse(GridRow $row, array $args)

Occurring before a grid row collapses its detail tables. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeDetailTablesCollapse($row,$args)
		{
			//$row: The grid row object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnDetailTablesCollapseTop

void OnDetailTablesCollapse(GridRow $row, array $args)

Occurring after a grid row collapses its detail tables.

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

Supported from version: 1.6.0.0

OnBeforeRowStartEditTop

bool OnBeforeRowStartEdit(GridRow $row, array $args)

Occurring before a grid row is in edit mode. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeRowStartEdit($row,$args)
		{
			//$row: The grid row object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnRowStartEditTop

void OnRowStartEdit(GridRow $row, array $args)

Occurring after a grid row is in edit mode.

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

Supported from version: 1.6.0.0

OnBeforeRowCancelEditTop

bool OnBeforeRowCancelEdit(GridRow $row, array $args)

Occurring before a grid row cancels editing. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeRowCancelEdit($row,$args)
		{
			//$row: The grid row object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnRowCancelEditTop

void OnRowCancelEdit(GridRow $row, array $args)

Occurring after a grid row cancels editing.

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

Supported from version: 1.6.0.0

OnBeforeRowDeleteTop

bool OnBeforeRowDelete(GridRow $row, array $args)

Occurring before a grid row is deleted. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeRowDelete($row,$args)
		{
			//$row: The grid row object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnRowDeleteTop

void OnRowDelete(GridRow $row, array $args)

Occurring after a grid row is deleted.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnRowDelete($row,$args)
		{
			//$row: The grid row object.
			//$args["Successful"]: bool value indicating whether row is deleted sucessfully.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnBeforeColumnSortTop

bool OnBeforeColumnSort(GridColumn $column, array $args)

Occurring before a grid column is sorted. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeColumnSort($column,$args)
		{
			//$column: The grid column object.
			//$args["NewSort"]: The value of sort is going to be apply.
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnColumnSortTop

void OnColumnSort(GridColumn $column, array $args)

Occurring after a grid column is sorted.

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

Supported from version: 1.6.0.0

OnBeforeColumnGroupTop

bool OnBeforeColumnGroup(GridColumn $column, array $args)

Occurring before a grid column is grouped. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeColumnGroup($column,$args)
		{
			//$column: The grid column object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnColumnGroupTop

void OnColumnGroup(GridColumn $column, array $args)

Occurring after a grid column is grouped.

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

Supported from version: 1.6.0.0

OnBeforeColumnFilterTop

bool OnBeforeColumnFilter(GridColumn $column, array $args)

Occurring before a grid column is filtered. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeColumnFilter($column,$args)
		{
			//$column: The grid column object.
			//$args["FilterExp"]: The filter expression is going to apply. 
			//$args["FilterValue"]: The filter value is going to apply.
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnColumnFilterTop

void OnColumnFilter(GridColumn $column, array $args)

Occurring after a grid column is filtered.

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

Supported from version: 1.6.0.0

OnBeforePageIndexChangeTop

bool OnBeforePageIndexChange(GridPager $pager, array $args)

Occurring before a grid pager changes its page index. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforePageIndexChange($pager,$args)
		{
			//$pager: The grid pager object.
			//$args["NewPageIndex"]: The new pager index.
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnPageIndexChangeTop

void OnPageIndexChange(GridPager $pager, array $args)

Occurring after a grid pager changes its page index.

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

Supported from version: 1.6.0.0

OnBeforePageSizeChangeTop

bool OnBeforePageSizeChange(GridPager $pager, array $args)

Occurring before a grid pager changes its page size. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforePageSizeChange($pager,$args)
		{
			//$pager: The grid pager object.
			//$args["NewPageSize"]: The new pager size.
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnPageSizeChangeTop

void OnPageSizeChange(GridPager $pager, array $args)

Occurring after a grid pager changes its page size.

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

Supported from version: 1.6.0.0

OnBeforeRowConfirmEditTop

bool OnBeforeRowConfirmEdit(GridRow $row, array $args)

Occurring before a grid row confirms edit. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeRowConfirmEdit($row,$args)
		{
			//$row: The grid row object.
			//$args["NewDataItem"]: New dataitem.
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnRowConfirmEditTop

void OnRowConfirmEdit(GridRow $row, array $args)

Occurring after a grid row confirms edit.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnRowConfirmEdit($row,$args)
		{
			//$row: The grid row object.
			//$args["NewDataItem"]: New dataitem
			//$args["Successful"]: Bool value which indicates whether the edit is successful.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnBeforeConfirmInsertTop

bool OnBeforeConfirmInsert(GridTableView $tableview, array $args)

Occurring before tableview adds a new row. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeConfirmInsert($tableview,$args)
		{
			//$tableview: The grid tableview object.
			//$args["NewDataItem"]: New dataitem
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnConfirmInsertTop

void OnConfirmInsert(GridTableView $tableview, array $args)

Occurring after tableview adds a new row.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnConfirmInsert($tableview,$args)
		{
			//$tableview: The grid tableview object.
			//$args["NewDataItem"]: New dataitem
			//$args["Successful"]: Bool value which indicates whether the insert is successful.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnBeforeStartInsertTop

bool OnBeforeStartInsert(GridTableView $tableview, array $args)

Occurring before tableview starts inserting a new row. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeStartInsert($row,$args)
		{
			//$tableview: The grid tableview object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnStartInsertTop

void OnStartInsert(GridTableView $tableview, array $args)

Occurring after tableview starts inserting a new row.

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

Supported from version: 1.6.0.0

OnBeforeCancelInsertTop

bool OnBeforeCancelInsert(GridTableView $tableview, array $args)

Occurring before tableview cancels inserting. You return true in handle function to approve the action, return true to cancel the action.

<?php				
	$grid = new KoolGrid("grid");
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeCancelInsert($row,$args)
		{
			//$tableview: The grid tableview object.
			//$args: No data
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();
?>

Supported from version: 1.6.0.0

OnCancelInsertTop

void OnCancelInsert(GridTableView $tableview, array $args)

Occurring after tableview cancels inserting.

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

Supported from version: 1.6.0.0

OnTableViewPreRenderTop

void OnTableViewPreRender(GridTableView $tableview, array $args)

Occurring before the tableview render. You can make any neccessary changes here before table is in rendering process.

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

Supported from version: 1.6.0.0

OnRowPreRenderTop

void OnRowPreRender(GridRow $row, array $args)

Occurring before a row renders. You can make any neccessary changes here before the row is in rendering process.

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

Supported from version: 1.6.0.0

OnGridPreRenderTop

void OnGridPreRender(KoolGrid $grid, array $args)

Occurring before the grid renders. You can make any neccessary changes here before the grid is in rendering process.

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

Supported from version: 1.6.0.0