Class \Prado\Web\UI\WebControls\THyperLinkColumn

THyperLinkColumn class

THyperLinkColumn contains a hyperlink for each item in the column. You can set the text and the url of the hyperlink by \Prado\Web\UI\WebControls\setText and \Prado\Web\UI\WebControls\setNavigateUrl properties, respectively. You can also bind the text and url to specific data field in datasource by setting \Prado\Web\UI\WebControls\setDataTextField and \Prado\Web\UI\WebControls\setDataNavigateUrlField. Both can be formatted before rendering according to the \Prado\Web\UI\WebControls\setDataTextFormatString and and \Prado\Web\UI\WebControls\setDataNavigateUrlFormatString properties, respectively. If both \Prado\Web\UI\WebControls\setText and \Prado\Web\UI\WebControls\setDataTextField are present, the latter takes precedence. The same rule applies to \Prado\Web\UI\WebControls\setNavigateUrl and \Prado\Web\UI\WebControls\setDataNavigateUrlField properties.

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

$datagridItem->HyperLinkColumnID->HyperLink
$datagridItem->HyperLinkColumnID->Controls[0]

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

Class hierarchy

\Prado\Web\UI\WebControls\THyperLinkColumn

\Prado\Web\UI\WebControls\TDataGridColumn

\Prado\TApplicationComponent

\Prado\TComponent

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

Methods summary
`public`	`dataBindColumn(mixed $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`	`getDataNavigateUrlField() : string`
`public`	`getDataNavigateUrlFormatString() : string`
`public`	`getDataTextField() : string`
`public`	`getDataTextFormatString() : string`
`public`	`getImageHeight() : string`
`public`	`getImageUrl() : string`
`public`	`getImageWidth() : string`
`public`	`getNavigateUrl() : string`
`public`	`getTarget() : string`
`public`	`getText() : 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 hyperlink within the cell.
`public`	`setDataNavigateUrlField(string $value) : mixed`
`public`	`setDataNavigateUrlFormatString(string $value) : mixed`
`public`	`setDataTextField(string $value) : mixed`
`public`	`setDataTextFormatString(string $value) : mixed`
`public`	`setImageHeight(string $value) : mixed`
`public`	`setImageUrl(string $value) : mixed`
`public`	`setImageWidth(string $value) : mixed`
`public`	`setNavigateUrl(string $value) : mixed` Sets the URL to link to when the hyperlink is clicked.
`public`	`setTarget(string $value) : mixed` Sets the target window or frame to display the Web page content linked to when the hyperlink is clicked.
`public`	`setText(string $value) : mixed` Sets the text caption of the hyperlink.

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\THyperLinkColumn

Class hierarchy