Class TLiteralColumn
TLiteralColumn class
TLiteralColumn represents a static text column that is bound to a field in a data source. The cells in the column will be displayed with static texts using the data indexed by DataField. You can customize the display by setting DataFormatString. If DataField is not specified, the cells will be filled with Text. If Encode is true, the static texts will be HTML-encoded.
| Method Summary |
|
void
|
Databinds a cell in the column.
|
|
string
|
|
|
string
|
|
|
boolean
|
|
|
string
|
|
|
void
|
Initializes the specified cell to its initial values.
|
|
void
|
|
|
void
|
|
|
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 |
|---|
|
getDataFormatString
| public string getDataFormatString |
() |
| Output |
|---|
|
string
| the formatting string used to control how the bound data will be displayed. |
| Exception |
|---|
|
getEncode
| public boolean getEncode |
() |
| Output |
|---|
|
boolean
| whether the rendered text should be HTML-encoded. Defaults to false. |
| Exception |
|---|
|
getText
| Output |
|---|
|
string
| static text to be displayed in the column. Defaults to empty. |
| 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.
| 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 |
|---|
|
setEncode
| public void setEncode |
(boolean $value ) |
| Input |
|---|
| boolean | $value | whether the rendered text should be HTML-encoded. |
| Output |
|---|
| Exception |
|---|
|
setText
| public void setText |
(string $value ) |
| Input |
|---|
| string | $value | static text to be displayed in the column. |
| Output |
|---|
| Exception |
|---|
|
|
