Class TBoundColumn
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 v3.1.0, TBoundColumn has introduced two new properties ItemRenderer and EditItemRenderer which can be used to specify the layout of the datagrid cells in browsing and editing mode. A renderer refers to a control class that is to be instantiated as a control. For more details, see TRepeater and TDataList.
Method Summary |
void
|
Databinds a cell in the column.
|
string
|
|
string
|
|
string
|
|
string
|
|
boolean
|
|
void
|
Initializes the specified cell to its initial values.
|
void
|
|
void
|
|
void
|
Sets the edit item cell renderer class.
|
void
|
Sets the item cell renderer class.
|
void
|
|
Methods Inherited From TDataGridColumn |
TDataGridColumn::formatDataValue(), TDataGridColumn::getAllowSorting(), TDataGridColumn::getDataFieldValue(), TDataGridColumn::getEnableCellGrouping(), TDataGridColumn::getFooterRenderer(), TDataGridColumn::getFooterStyle(), TDataGridColumn::getFooterText(), TDataGridColumn::getHeaderImageUrl(), TDataGridColumn::getHeaderRenderer(), TDataGridColumn::getHeaderStyle(), TDataGridColumn::getHeaderText(), TDataGridColumn::getID(), TDataGridColumn::getItemStyle(), TDataGridColumn::getOwner(), TDataGridColumn::getSortExpression(), TDataGridColumn::getViewState(), TDataGridColumn::getVisible(), TDataGridColumn::initialize(), TDataGridColumn::initializeCell(), TDataGridColumn::initializeFooterCell(), TDataGridColumn::initializeHeaderCell(), TDataGridColumn::loadState(), TDataGridColumn::saveState(), TDataGridColumn::setEnableCellGrouping(), TDataGridColumn::setFooterRenderer(), TDataGridColumn::setFooterText(), TDataGridColumn::setHeaderImageUrl(), TDataGridColumn::setHeaderRenderer(), TDataGridColumn::setHeaderText(), TDataGridColumn::setID(), TDataGridColumn::setOwner(), TDataGridColumn::setSortExpression(), TDataGridColumn::setViewState(), TDataGridColumn::setVisible()
|
Methods 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()
|
Method Details |
dataBindColumn
public void dataBindColumn |
(mixed $sender , mixed $param ) |
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.
Input |
mixed | $sender | |
mixed | $param | |
Output |
Exception |
|
getDataField
public string getDataField |
() |
Output |
string
| the field name from the data source to bind to the column |
Exception |
|
getDataFormatString
public string getDataFormatString |
() |
Output |
string
| the formatting string used to control how the bound data will be displayed. |
Exception |
|
getEditItemRenderer
public string getEditItemRenderer |
() |
Output |
string
| the class name for the edit item cell renderer. Defaults to empty, meaning not set. |
Exception |
|
getItemRenderer
public string getItemRenderer |
() |
Output |
string
| the class name for the item cell renderer. Defaults to empty, meaning not set. |
Exception |
|
getReadOnly
public boolean getReadOnly |
() |
Output |
boolean
| whether the items in the column can be edited. Defaults to false. |
Exception |
|
initializeCell
public void initializeCell |
(TTableCell $cell , integer $columnIndex , string $itemType ) |
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.
Input |
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) |
Output |
Exception |
|
setDataField
public void setDataField |
(string $value ) |
Input |
string | $value | the field name from the data source to bind to the column |
Output |
Exception |
|
setDataFormatString
public void setDataFormatString |
(string $value ) |
Input |
string | $value | the formatting string used to control how the bound data will be displayed. |
Output |
Exception |
|
setEditItemRenderer
public void setEditItemRenderer |
(string $value ) |
Sets the edit item cell renderer class.
If not empty, the class will be used to instantiate as a child control in the item cell that is in edit mode. If the class implements IDataRenderer, the Data property will be set as the data associated with the datagrid cell during databinding. The data can be either the whole data row or a field of the row if DataField is not empty. If DataFormatString is not empty, the data will be formatted first before passing to the renderer.
Input |
string | $value | the renderer class name in namespace format. |
Output |
Exception |
|
setItemRenderer
public void setItemRenderer |
(string $value ) |
Sets the item cell renderer class.
If not empty, the class will be used to instantiate as a child control in the item cells of the column. If the class implements IDataRenderer, the Data property will be set as the data associated with the datagrid cell during databinding. The data can be either the whole data row or a field of the row if DataField is not empty. If DataFormatString is not empty, the data will be formatted first before passing to the renderer.
Input |
string | $value | the renderer class name in namespace format. |
Output |
Exception |
|
setReadOnly
public void setReadOnly |
(boolean $value ) |
Input |
boolean | $value | whether the items in the column can be edited |
Output |
Exception |
|
|