Class \Prado\Web\UI\WebControls\TButtonColumn

TButtonColumn class

TButtonColumn contains a user-defined command button, such as Add or Remove, that corresponds with each row in the column.

The caption of the buttons in the column is determined by \Prado\Web\UI\WebControls\setText and \Prado\Web\UI\WebControls\setDataTextField properties. If both are present, the latter takes precedence. The \Prado\Web\UI\WebControls\setDataTextField property refers to the name of the field in datasource whose value will be used as the button caption. If \Prado\Web\UI\WebControls\setDataTextFormatString is not empty, the value will be formatted before rendering.

The buttons in the column can be set to display as hyperlinks, push buttons or images by setting the \Prado\Web\UI\WebControls\setButtonType property. The \Prado\Web\UI\WebControls\setCommandName will assign its value to all button's CommandName property. The datagrid will capture the command event where you can write event handlers based on different command names. The buttons' CausesValidation and ValidationGroup property values are determined by the column's corresponding properties.

The buttons in the column can be accessed by one of the following two methods:

$datagridItem->ButtonColumnID->Button
$datagridItem->ButtonColumnID->Controls[0]

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

Class hierarchy

\Prado\Web\UI\WebControls\TButtonColumn

\Prado\Web\UI\WebControls\TDataGridColumn

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`dataBindColumn(TWebControl $sender, mixed $param) : mixed` 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.
`public`	`getButtonType() : TButtonColumnType`
`public`	`getCausesValidation() : bool`
`public`	`getCommandName() : string`
`public`	`getDataImageUrlField() : string`
`public`	`getDataImageUrlFormatString() : string`
`public`	`getDataTextField() : string`
`public`	`getDataTextFormatString() : string`
`public`	`getImageUrl() : string`
`public`	`getText() : string`
`public`	`getValidationGroup() : string`
`public`	`initializeCell(TTableCell $cell, int $columnIndex, string $itemType) : mixed` Initializes the specified cell to its initial values. This method overrides the parent implementation. It creates a command button within the cell.
`public`	`setButtonType(TButtonColumnType $value) : mixed`
`public`	`setCausesValidation(bool $value) : mixed`
`public`	`setCommandName(string $value) : mixed` Sets the command name associated with the <b>Command</b> event.
`public`	`setDataImageUrlField(string $value) : mixed`
`public`	`setDataImageUrlFormatString(string $value) : mixed`
`public`	`setDataTextField(string $value) : mixed`
`public`	`setDataTextFormatString(string $value) : mixed`
`public`	`setImageUrl(string $value) : mixed`
`public`	`setText(string $value) : mixed` Sets the text caption of the button.
`public`	`setValidationGroup(string $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAllowSorting, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnableCellGrouping, getEventHandlers, getFooterRenderer, getFooterStyle, getFooterText, getHeaderImageUrl, getHeaderRenderer, getHeaderStyle, getHeaderText, getID, getItemStyle, getListeningToGlobalEvents, getOwner, getRequest, getResponse, getService, getSession, getSortExpression, getSubProperty, getUser, getVisible, hasEvent, hasEventHandler, hasMethod, hasProperty, initialize, initializeCell, isa, listen, loadState, publishAsset, publishFilePath, raiseEvent, saveState, setEnableCellGrouping, setFooterRenderer, setFooterText, setHeaderImageUrl, setHeaderRenderer, setHeaderText, setID, setOwner, setSortExpression, setSubProperty, setVisible, unlisten, _getZappableSleepProps, formatDataValue, getCallChain, getClassFxEvents, getDataFieldValue, getViewState, initializeCellRendererControl, initializeFooterCell, initializeHeaderCell, instanceBehavior, setViewState, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TButtonColumn

Class hierarchy