Class TCheckBoxColumn
TCheckBoxColumn class
TCheckBoxColumn represents a checkbox column that is bound to a field in a data source. The checked state of the checkboxes are determiend by the bound data at DataField. If ReadOnly is false, TCheckBoxColumn will display an enabled checkbox provided the cells are in edit mode. Otherwise, the checkboxes will be disabled to prevent from editting. The checkbox control in the TCheckBoxColumn can be accessed by one of the following two methods: - $datagridItem->CheckBoxColumnID->CheckBox
- $datagridItem->CheckBoxColumnID->Controls[0]
The second method is possible because the checkbox control created within the datagrid cell is the first child.
Method Summary |
void
|
Databinds a cell in the column.
|
string
|
|
boolean
|
|
void
|
Initializes the specified cell to its initial values.
|
void
|
|
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 |
|
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 checkbox inside the cell. If the column is read-only or if the item is not in edit mode, the checkbox will be set disabled.
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 |
|
setReadOnly
public void setReadOnly |
(boolean $value ) |
Input |
boolean | $value | whether the items in the column can be edited |
Output |
Exception |
|
|