GridTableView Class [PHP]

AllowDeletingTop

bool AllowDeleting

Allow tableview delete data.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowDeleting = true;
?>

Supported from version: 1.0.0.0

AllowEditingTop

bool AllowEditing

Allow tableview edit and update data to datasource.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowEditing = true;
?>

Supported from version: 1.0.0.0

AllowFilteringTop

bool AllowFiltering

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowFiltering = true;
?>

Supported from version: 1.0.0.0

AllowGroupingTop

bool AllowGrouping

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowGrouping = true;
?>

Supported from version: 2.0.0.0

AllowHoveringTop

bool AllowHovering

Allow row highlighted when mouse is over.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowHovering = true;
?>

Supported from version: 1.0.0.0

AllowMultiSelectingTop

bool AllowMultiSelecting

Allow selecting more than one row.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowMultiSelecting = true;
?>

Supported from version: 1.0.0.0

AllowResizingTop

bool AllowResizing

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowResizing = true;
?>

Supported from version: 1.0.0.0

AllowScrollingTop

bool AllowScrolling

Allow tableview scrollable.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowScrolling = true;
?>

Supported from version: 1.0.0.0

AllowSelectingTop

bool AllowSelecting

Allow row selected

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowSelecting = true;
?>

Supported from version: 1.0.0.0

AllowSortingTop

bool AllowSorting

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AllowSorting = true;
?>

Supported from version: 1.0.0.0

AutoGenerateColumnsTop

bool AutoGenerateColumns

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AutoGenerateColumns = true;
?>

Supported from version: 1.0.0.0

AutoGenerateDeleteColumnTop

bool AutoGenerateDeleteColumn

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AutoGenerateDeleteColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateEditColumnTop

bool AutoGenerateEditColumn

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AutoGenerateEditColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateExpandColumnTop

bool AutoGenerateExpandColumn

When true, grid will add GridExpandDetailColumn to the tableview automatically.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AutoGenerateExpandColumn = true;
?>

Supported from version: 1.0.0.0

AutoGenerateRowSelectColumnTop

bool AutoGenerateRowSelectColumn

When true, grid will add GridRowSelectColumn to tableview automatically.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->AutoGenerateRowSelectColumn = true;
?>

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				
	$tableview = new GridTableView();
	$tableview->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				
	$tableview = new GridTableView();
	$tableview->ColumnValign  = "top";
?>

Supported from version: 1.0.0.0

ColumnWrapTop

bool ColumnWrap

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ColumnWrap = true;
?>

Supported from version: 1.0.0.0

DataKeyNamesTop

string DataKeyNames

Get or set list of primary keys of the data set. You can input multiple primary key name with comma seperator.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->DataKeyNames  = "customerNumber";
?>

Supported from version: 1.0.0.0

DataSourceTop

string DataSource

Get or set the datasource for tableview.

Show/Hide Code

<?php				
	$ds = new MySQLDataSource();
	$ds->SelectCommand = "select customerNumber,customerName from customers";
	$tableview = new GridTableView();
	$tableview->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->MasterTable->AutoGenerateColumns  = true;
	$grid->MasterTable->DisableAutoGenerateDataFields  = "ID,customerNumber"; //Do not create columns for ID and customerNumber field.
?>

Supported from version: 1.0.0.0

EditSettingsTop

EditSettings EditSettings

Contain settings for tableview editing data function. More detail of settings you may have a look at EditSettings class.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->EditSettings->Mode = "Form";
?>

Supported from version: 1.0.0.0

FilterOptionsTop

array FilterOptions

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

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				
	$tableview = new GridTableView();
	$tableview->FilterOptions  = array("No_Filter","Greater_Than","Less_Than");//Only show 3 chosen options.
?>

Supported from version: 1.0.0.0

FrozenColumnsCountTop

bool FrozenColumnsCount

Specify number of columns in table that will stay still regardless of scrolling action. This should be used with AllowScrolling set to true.

Show/Hide Code

<?php				
	$grid->MasterTable->AllowScrolling = true;
	$grid->MasterTable->Height = "300px";	
	$grid->MasterTable->FrozenColumnsCount = 2;
 
?>

Supported from version: 4.0.0.0

FunctionPanelTop

FunctionPanel FunctionPanel

TableView's function panel settings.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowFunctionPanel = true;
	$tableview->FunctionPanel->RefreshButtonText = "Reload";
?>

Supported from version: 1.0.0.0

GridTop

KoolGrid Grid

Get the grid object that contain this tableview. Note: This property is only available after grid has been processed.

Show/Hide Code

<?php				
 
?>

Supported from version: 1.6.0.0

GroupPanelTop

GroupPanel GroupPanel

TableView's group panel settings.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowGroupPanel = true;
	$tableview->GroupPanel->ItemConnector = ">";
?>

Supported from version: 1.0.0.0

HeightTop

string Height

Get or set height of tableview. The height can only be set with px value.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->Height  = "300px";
?>

Supported from version: 1.0.0.0

InsertSettingsTop

InsertSettings InsertSettings

Contain settings for tableview inserting data function. More detail of settings you may have a look at InsertSettings class

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->InsertSettings->Mode = "Form";
?>

Supported from version: 1.0.0.0

KeepRowStateOnRefreshTop

bool KeepRowStateOnRefresh

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->KeepRowStateOnRefresh = true;
?>

Supported from version: 3.0.0.0

KeepSelectedRecordsTop

bool KeepSelectedRecords

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->KeepSelectedRecords = true;
?>

Supported from version: 1.0.0.0

NameTop

string Name

Get or set the name of table. This name can be used to differentiate tables in client-side or server-side event handling.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->Name  = "order_table";
 
 
	class MyGridEventHandler extends GridEventHandler
	{
		function OnBeforeConfirmInsert($tableview,$args)
		{
 
			if($tableview->Name=="order_table")
			{
				//Do something.
			}
 
			return true;//Approve the action.
		}
	}
	$grid->EventHandler = new MyGridEventHandler();	
?>

Supported from version: 1.0.0.0

PagerTop

GridPager Pager

Get or set pager object for tableview.

Default value : null

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->Pager  = new GridPrevNextColumn();
?>

Supported from version: 1.0.0.0

PageSizeTop

int PageSize

Get or set the page size for tableview.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->PageSize  = 20;
?>

Supported from version: 1.0.0.0

ParentRowTop

GridRow ParentRow

Get the parent row instance which contains this detail tableview. Note: This property is only available after grid has been processed.

Show/Hide Code

<?php				
 
?>

Supported from version: 1.6.0.0

RowAlternativeTop

bool RowAlternative

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

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->RowAlternative = true;
?>

Supported from version: 1.0.0.0

SelectedKeysTop

array SelectedKeys

Get the keys of selected rows. This list will be available after the grid processing. Note: This SelectedKeys requires DataKeyNames to be set.

Show/Hide Code

<?php
...
	$grid->MasterTable->DataKeyNames = "customerNumber";
...
	$grid->Process();				
	$selectedKeys = $grid->GetInstanceMasterTable()->SelectKeys;
	for(var $i=0;$i<sizeof($selectedKeys);$i++)
	{
		echo selectedKeys[$i]["customerName"];
	}
 
?>

Supported from version: 1.0.0.0

ShowFooterTop

bool ShowFooter

When true, it make footer of tableview visible.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowFooter = true;
?>

Supported from version: 1.0.0.0

ShowFunctionPanelTop

bool ShowFunctionPanel

When true, tableview will show function panel.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowFunctionPanel = true;
	$tableview->FunctionPanel->RefreshButtonText = "Reload";
?>

Supported from version: 1.0.0.0

ShowGroupPanelTop

bool ShowGroupPanel

When true, tableview will show group panel.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowGroupPanel = true;
	$tableview->GroupPanel->ItemConnector = ">";
?>

Supported from version: 2.0.0.0

ShowHeaderTop

bool ShowHeader

When true, it make header of tableview visible.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->ShowHeader = 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				
	$tableview = new GridTableView();
	$tableview->SingleColumnSorting = true;
?>

Supported from version: 1.0.0.0

TableLayoutTop

string TableLayout

Get or set layout of the tableview.

Default value : "auto"

Allowed values :

• "auto" : The width of table will be set automatically.
• "fixed" : Use the fixed width for tableview.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->TableLayout  = "fixed";
?>

Supported from version: 1.0.0.0

VirtualScrollingTop

bool VirtualScrolling

When true, the grid will perform virtual scrolling. This should be used with AllowScrolling set to true.

Show/Hide Code

<?php				
	$grid->MasterTable->AllowScrolling = true;
	$grid->MasterTable->Height = "300px";	
	$grid->MasterTable->VirtualScrolling = true;
?>

Supported from version: 4.0.0.0

WidthTop

string Width

Get or set detfault width of the tableview. The width can be set with px value of % value.

Show/Hide Code

<?php				
	$tableview = new GridTableView();
	$tableview->Width  = "900px";
?>

Supported from version: 1.0.0.0

RefreshTop

void Refresh()

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

Show/Hide Code

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

Supported from version: 1.6.0.0

GetInstanceRowsTop

array GetInstanceRows()

Get all instance rows of tableview after processing.

Show/Hide Code

<?php 
...
	$grid->Process();
	$mastertable = $grid->GetInstanceMasterTable();
	$rows = $mastertable->GetInstanceRows();
?>

Supported from version: 1.0.0.0

GetInstanceColumnsTop

array GetInstanceColumns()

Get all instance columns of tableview after processing.

Show/Hide Code

<?php 
...
	$grid->Process();
	$mastertable = $grid->GetInstanceMasterTable();
	$columns = $mastertable->GetInstanceColumns();
?>

Supported from version: 1.0.0.0

AddColumnTop

void AddColumn(GridColumn $column)

Add a column to tableview.

Show/Hide Code

<?php 
	$col = new GridBoundColumn();
	$col->DataField = "customerNumber";
	$grid->MasterTable->AddColumn($col);
?>

Supported from version: 1.0.0.0

AddGroupTop

void AddGroup(GridGroup $group)

Add a group to tableview.

Show/Hide Code

<?php 
	$group = new GridGroup();
	$group->GroupField = "supervisor_name";
	$group->AddInfoField("reportsTo");
	$group->HeaderText = "Supervisor";
	$group->InfoTemplate = "Report To: {supervisor_name}";
	$grid->MasterTable->AddGroup($group);
?>

Supported from version: 2.0.0.0

AddDetailTableTop

void AddDetailTable(GridTableView $detail_table, [string $description_template])

Add a detail table to tableview.

Show/Hide Code

<?php 
	$table = new GridTableView();
	$table->DataSource = $detail_ds;
	$table->AddRelationField("customerNumber","customerNumber");
	$grid->MasterTable->AddDetailTable($table,"Detail orders of <b>{customerName}</b>");
	//Note: "customerName" should be a field in parent table ( MasterTable in this case )
?>

Supported from version: 1.0.0.0

AddRelationFieldTop

void AddRelationField(string $field_of_this_detail_table, string $field_of_master_table)

Add relation field between detail table and master table.

Show/Hide Code

<?php 
	$table = new GridTableView();
	$table->DataSource = $detail_ds;
	$table->AddRelationField("customerNumber","customerNumber");
	$grid->MasterTable->AddDetailTable($table);
?>

Supported from version: 1.0.0.0

ExportToCSVTop

void ExportToCSV()

Export the tableview to CSV format.

Show/Hide Code

<?php 
	...
	$grid->Process();
	//Asuume that an ExportToCSV input button is clicked.
	if(isset($_POST["ExportToCSV"]))
	{
		$grid->GetInstanceMasterTable()->ExportToCSV();
	}
?>

Supported from version: 1.0.0.0

ExportToPDFTop

void ExportToPDF()

Export the tableview to PDF format.

Show/Hide Code

<?php 
	...
	$grid->Process();
	//Asuume that an ExportToPDF input button is clicked.
	if(isset($_POST["ExportToPDF"]))
	{
		$grid->GetInstanceMasterTable()->ExportToPDF();
	}
?>

Supported from version: 2.0.0.0

ExportToExcelTop

void ExportToExcel()

Export the tableview to Microsoft Excel format.

Show/Hide Code

<?php 
	...
	$grid->Process();
	//Asuume that an ExportToExcel input button is clicked.
	if(isset($_POST["ExportToExcel"]))
	{
		$grid->GetInstanceMasterTable()->ExportToExcel();
	}
?>

Supported from version: 2.0.0.0

ExportToWordTop

void ExportToWord()

Export the tableview to Microsoft Word format.

Show/Hide Code

<?php 
	...
	$grid->Process();
	//Asuume that an ExportToWord input button is clicked.
	if(isset($_POST["ExportToWord"]))
	{
		$grid->GetInstanceMasterTable()->ExportToWord();
	}
?>

Supported from version: 2.0.0.0

GetParentRowTop

GridRow GetParentRow()

Return the parent row that contains this tableview.

Show/Hide Code

<?php 
 
?>

Supported from version: 2.1.0.0

GetUniqueIDTop

string GetUniqueID()

Return the tableview's unique ID which is assigned by KoolGrid.

Show/Hide Code

Supported from version: 2.3.0.0