PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class 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 setText Text and setNavigateUrl NavigateUrl properties, respectively. You can also bind the text and url to specific data field in datasource by setting setDataTextField DataTextField and setDataNavigateUrlField DataNavigateUrlField. Both can be formatted before rendering according to the setDataTextFormatString DataTextFormatString and and setDataNavigateUrlFormatString DataNavigateUrlFormatString properties, respectively. If both setText Text and setDataTextField DataTextField are present, the latter takes precedence. The same rule applies to setNavigateUrl NavigateUrl and 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.

TComponent
Extended by TApplicationComponent
Extended by TDataGridColumn
Extended by THyperLinkColumn

Direct known subclasses

TActiveHyperLinkColumn
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/THyperLinkColumn.php
Methods summary
public string
# getText( )

Returns

string
the text caption of the hyperlink
public
# setText( string $value )

Sets the text caption of the hyperlink.

Sets the text caption of the hyperlink.

Parameters

$value
string
the text caption to be set
public string
# getDataTextField( )

Returns

string
the field name from the data source to bind to the hyperlink caption
public
# setDataTextField( string $value )

Parameters

$value
string
the field name from the data source to bind to the hyperlink caption
public string
# getDataTextFormatString( )

Returns

string
the formatting string used to control how the hyperlink caption will be displayed.
public
# setDataTextFormatString( string $value )

Parameters

$value
string
the formatting string used to control how the hyperlink caption will be displayed.
public string
# getImageHeight( )

Returns

string
height of the image in the THyperLink
public
# setImageHeight( string $value )

Parameters

$value
string
height of the image in the THyperLink
public string
# getImageUrl( )

Returns

string
url of the image in the THyperLink
public
# setImageUrl( string $value )

Parameters

$value
string
url of the image in the THyperLink
public string
# getImageWidth( )

Returns

string
width of the image in the THyperLink
public
# setImageWidth( string $value )

Parameters

$value
string
width of the image in the THyperLink
public string
# getNavigateUrl( )

Returns

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

Sets the URL to link to when the hyperlink is clicked.

Sets the URL to link to when the hyperlink is clicked.

Parameters

$value
string
the URL
public string
# getDataNavigateUrlField( )

Returns

string
the field name from the data source to bind to the navigate url of hyperlink
public
# setDataNavigateUrlField( string $value )

Parameters

$value
string
the field name from the data source to bind to the navigate url of hyperlink
public string
# getDataNavigateUrlFormatString( )

Returns

string
the formatting string used to control how the navigate url of hyperlink will be displayed.
public
# setDataNavigateUrlFormatString( string $value )

Parameters

$value
string
the formatting string used to control how the navigate url of hyperlink will be displayed.
public string
# getTarget( )

Returns

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

Sets the target window or frame to display the Web page content linked to when the hyperlink is clicked.

Sets the target window or frame to display the Web page content linked to when the hyperlink is clicked.

Parameters

$value
string
the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string.
public
# initializeCell( TTableCell $cell, integer $columnIndex, string $itemType )

Initializes the specified cell to its initial values. This method overrides the parent implementation. It creates a hyperlink within the cell.

Initializes the specified cell to its initial values. This method overrides the parent implementation. It creates a hyperlink within the cell.

Parameters

$cell
TTableCell
the cell to be initialized.
$columnIndex
integer
the index to the Columns property that the cell resides in.
$itemType
string
the type of cell (Header,Footer,Item,AlternatingItem,EditItem,SelectedItem)

Overrides

TDataGridColumn::initializeCell()
public
# 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.

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.

Methods inherited from TDataGridColumn
formatDataValue(), getAllowSorting(), getDataFieldValue(), getEnableCellGrouping(), getFooterRenderer(), getFooterStyle(), getFooterText(), getHeaderImageUrl(), getHeaderRenderer(), getHeaderStyle(), getHeaderText(), getID(), getItemStyle(), getOwner(), getSortExpression(), getViewState(), getVisible(), initialize(), initializeFooterCell(), initializeHeaderCell(), loadState(), saveState(), setEnableCellGrouping(), setFooterRenderer(), setFooterText(), setHeaderImageUrl(), setHeaderRenderer(), setHeaderText(), setID(), setOwner(), setSortExpression(), setViewState(), setVisible()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO