PHP Class Prado\Web\UI\WebControls\THyperLinkColumn

THyperLinkColumn contains a hyperlink for each item in the column. You can set the text and the url of the hyperlink by {@link setText Text} and {@link setNavigateUrl NavigateUrl} properties, respectively. You can also bind the text and url to specific data field in datasource by setting {@link setDataTextField DataTextField} and {@link setDataNavigateUrlField DataNavigateUrlField}. Both can be formatted before rendering according to the {@link setDataTextFormatString DataTextFormatString} and and {@link setDataNavigateUrlFormatString DataNavigateUrlFormatString} properties, respectively. If both {@link setText Text} and {@link setDataTextField DataTextField} are present, the latter takes precedence. The same rule applies to {@link setNavigateUrl NavigateUrl} and {@link setDataNavigateUrlField DataNavigateUrlField} 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.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TDataGridColumn
Mostrar archivo Open project: pradosoft/prado

Public Methods

Method Description
dataBindColumn ( $sender, $param ) Databinds a cell in the column.
getDataNavigateUrlField ( ) : string
getDataNavigateUrlFormatString ( ) : string
getDataTextField ( ) : string
getDataTextFormatString ( ) : string
getImageHeight ( ) : string
getImageUrl ( ) : string
getImageWidth ( ) : string
getNavigateUrl ( ) : string
getTarget ( ) : string
getText ( ) : string
initializeCell ( $cell, $columnIndex, $itemType ) Initializes the specified cell to its initial values.
setDataNavigateUrlField ( $value )
setDataNavigateUrlFormatString ( $value )
setDataTextField ( $value )
setDataTextFormatString ( $value )
setImageHeight ( $value )
setImageUrl ( $value )
setImageWidth ( $value )
setNavigateUrl ( $value ) Sets the URL to link to when the hyperlink is clicked.
setTarget ( $value ) Sets the target window or frame to display the Web page content linked to when the hyperlink is clicked.
setText ( $value ) Sets the text caption of the hyperlink.

Method Details

dataBindColumn() public method

This method is invoked when datagrid performs databinding. It populates the content of the cell with the relevant data from data source.
public dataBindColumn ( $sender, $param )

getDataNavigateUrlField() public method

public getDataNavigateUrlField ( ) : string
return string the field name from the data source to bind to the navigate url of hyperlink

getDataNavigateUrlFormatString() public method

public getDataNavigateUrlFormatString ( ) : string
return string the formatting string used to control how the navigate url of hyperlink will be displayed.

getDataTextField() public method

public getDataTextField ( ) : string
return string the field name from the data source to bind to the hyperlink caption

getDataTextFormatString() public method

public getDataTextFormatString ( ) : string
return string the formatting string used to control how the hyperlink caption will be displayed.

getImageHeight() public method

public getImageHeight ( ) : string
return string height of the image in the THyperLink

getImageUrl() public method

public getImageUrl ( ) : string
return string url of the image in the THyperLink

getImageWidth() public method

public getImageWidth ( ) : string
return string width of the image in the THyperLink

getNavigateUrl() public method

public getNavigateUrl ( ) : string
return string the URL to link to when the hyperlink is clicked.

getTarget() public method

public getTarget ( ) : string
return string the target window or frame to display the Web page content linked to when the hyperlink is clicked.

getText() public method

public getText ( ) : string
return string the text caption of the hyperlink

initializeCell() public method

This method overrides the parent implementation. It creates a hyperlink within the cell.
public initializeCell ( $cell, $columnIndex, $itemType )

setDataNavigateUrlField() public method

public setDataNavigateUrlField ( $value )

setDataNavigateUrlFormatString() public method

public setDataNavigateUrlFormatString ( $value )

setDataTextField() public method

public setDataTextField ( $value )

setDataTextFormatString() public method

public setDataTextFormatString ( $value )

setImageHeight() public method

public setImageHeight ( $value )

setImageUrl() public method

public setImageUrl ( $value )

setImageWidth() public method

public setImageWidth ( $value )

setNavigateUrl() public method

Sets the URL to link to when the hyperlink is clicked.
public setNavigateUrl ( $value )

setTarget() public method

Sets the target window or frame to display the Web page content linked to when the hyperlink is clicked.
public setTarget ( $value )

setText() public method

Sets the text caption of the hyperlink.
public setText ( $value )