Docs For Class TBoundColumn

Description

TBoundColumn class

TBoundColumn represents a column that is bound to a field in a data source. The cells in the column will be displayed using the data indexed by DataField. You can customize the display by setting DataFormatString.

If ReadOnly is false, TBoundColumn will display cells in edit mode with textboxes. Otherwise, a static text is displayed.

When a datagrid row is in edit mode, the textbox control in the TBoundColumn can be accessed by one of the following two methods:

 $datagridItem->BoundColumnID->TextBox
 $datagridItem->BoundColumnID->Controls[0]

The second method is possible because the textbox control created within the datagrid cell is the first child.

since: 3.0
version: $Id: TBoundColumn.php 1398 2006-09-08 19:31:03Z xue $
author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TBoundColumn.php (line 43)

TComponent
   |
   --TApplicationComponent
      |
      --TDataGridColumn
         |
         --TBoundColumn

Method Summary

void dataBindColumn (mixed $sender, mixed $param)

string getDataField ()

string getDataFormatString ()

boolean getReadOnly ()

void initializeCell (TTableCell $cell, integer $columnIndex, string $itemType)

void setDataField (string $value)

void setDataFormatString (string $value)

void setReadOnly (boolean $value)

Methods

dataBindColumn (line 135)

Databinds a cell in the column.

This method is invoked when datagrid performs databinding. It populates the content of the cell with the relevant data from data source.

access: public

void dataBindColumn (mixed $sender, mixed $param)

getDataField (line 48)

return: the field name from the data source to bind to the column
access: public

string getDataField ()

getDataFormatString (line 64)

return: the formatting string used to control how the bound data will be displayed.
access: public

string getDataFormatString ()

getReadOnly (line 80)

return: whether the items in the column can be edited. Defaults to false.
access: public

boolean getReadOnly ()

initializeCell (line 104)

Initializes the specified cell to its initial values.

This method overrides the parent implementation. It creates a textbox for item in edit mode and the column is not read-only. Otherwise it displays a static text. The caption of the button and the static text are retrieved from the datasource.

access: public

void initializeCell (TTableCell $cell, integer $columnIndex, string $itemType)

TTableCell $cell: the cell to be initialized.
integer $columnIndex: the index to the Columns property that the cell resides in.
string $itemType: the type of cell (Header,Footer,Item,AlternatingItem,EditItem,SelectedItem)

Redefinition of:

TDataGridColumn::initializeCell(): Initializes the specified cell to its initial values.

setDataField (line 56)

access: public

void setDataField (string $value)

string $value: the field name from the data source to bind to the column

setDataFormatString (line 72)

access: public

void setDataFormatString (string $value)

string $value: the formatting string used to control how the bound data will be displayed.

setReadOnly (line 88)

access: public

void setReadOnly (boolean $value)

boolean $value: whether the items in the column can be edited

Inherited Methods

Inherited From TDataGridColumn

TDataGridColumn::formatDataValue()
TDataGridColumn::getDataFieldValue()
TDataGridColumn::getFooterStyle()
TDataGridColumn::getFooterText()
TDataGridColumn::getHeaderImageUrl()
TDataGridColumn::getHeaderStyle()
TDataGridColumn::getHeaderText()
TDataGridColumn::getID()
TDataGridColumn::getItemStyle()
TDataGridColumn::getOwner()
TDataGridColumn::getSortExpression()
TDataGridColumn::getViewState()
TDataGridColumn::getVisible()
TDataGridColumn::initialize()
TDataGridColumn::initializeCell()
TDataGridColumn::loadState()
TDataGridColumn::saveState()
TDataGridColumn::setFooterText()
TDataGridColumn::setHeaderImageUrl()
TDataGridColumn::setHeaderText()
TDataGridColumn::setID()
TDataGridColumn::setOwner()
TDataGridColumn::setSortExpression()
TDataGridColumn::setViewState()
TDataGridColumn::setVisible()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()