## Class THyperLinkColumn

Description

THyperLinkColumn class

THyperLinkColumn contains a hyperlink for each item in the column. You can set the text and the url of the hyperlink by Text and NavigateUrl properties, respectively. You can also bind the text and url to specific data field in datasource by setting DataTextField and DataNavigateUrlField. Both can be formatted before rendering according to the DataTextFormatString and and DataNavigateUrlFormatString properties, respectively. If both Text and DataTextField are present, the latter takes precedence. The same rule applies to NavigateUrl and DataNavigateUrlField properties.

- since: 3.0
- version: $Revision: $ $Date: $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/THyperLinkColumn.php (line 44)

    TComponent
       |
       --TApplicationComponent
          |
          --TDataGridColumn
             |
             --THyperLinkColumn

Method Summary
void dataBindColumn (mixed $sender, mixed $param)
string getDataNavigateUrlField ()
string getDataNavigateUrlFormatString ()
string getDataTextField ()
string getDataTextFormatString ()
string getNavigateUrl ()
string getTarget ()
string getText ()
void initializeCell (TTableCell $cell, integer $columnIndex, string $itemType)
void setDataNavigateUrlField (string $value)
void setDataNavigateUrlFormatString (string $value)
void setDataTextField (string $value)
void setDataTextFormatString (string $value)
void setNavigateUrl (string $value)
void setTarget (string $value)
void setText (string $value)
Methods
dataBindColumn (line 189)

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.

- access: public

void dataBindColumn (mixed $sender, mixed $param)
getDataNavigateUrlField (line 115)

- return: the field name from the data source to bind to the navigate url of hyperlink
- access: public

string getDataNavigateUrlField ()
getDataNavigateUrlFormatString (line 131)

- return: the formatting string used to control how the navigate url of hyperlink will be displayed.
- access: public

string getDataNavigateUrlFormatString ()
getDataTextField (line 66)

- return: the field name from the data source to bind to the hyperlink caption
- access: public

string getDataTextField ()
getDataTextFormatString (line 82)

- return: the formatting string used to control how the hyperlink caption will be displayed.
- access: public

string getDataTextFormatString ()
getNavigateUrl (line 98)

- return: the URL to link to when the hyperlink is clicked.
- access: public

string getNavigateUrl ()
getTarget (line 147)

- return: the target window or frame to display the Web page content linked to when the hyperlink is clicked.
- access: public

string getTarget ()
getText (line 49)

- return: the text caption of the hyperlink
- access: public

string getText ()
initializeCell (line 169)

Initializes the specified cell to its initial values.

This method overrides the parent implementation. It creates a hyperlink within the cell.

- access: public

void initializeCell (TTableCell $cell, integer $columnIndex, string $itemType)

- 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)

Redefinition of:

TDataGridColumn::initializeCell()
  Initializes the specified cell to its initial values.

setDataNavigateUrlField (line 123)

- access: public

void setDataNavigateUrlField (string $value)

- string $value: the field name from the data source to bind to the navigate url of hyperlink

setDataNavigateUrlFormatString (line 139)

- access: public

void setDataNavigateUrlFormatString (string $value)

- string $value: the formatting string used to control how the navigate url of hyperlink will be displayed.

setDataTextField (line 74)

- access: public

void setDataTextField (string $value)

- string $value: the field name from the data source to bind to the hyperlink caption

setDataTextFormatString (line 90)

- access: public

void setDataTextFormatString (string $value)

- string $value: the formatting string used to control how the hyperlink caption will be displayed.

setNavigateUrl (line 107)

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

- access: public

void setNavigateUrl (string $value)

- string $value: the URL

setTarget (line 156)

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

- access: public

void setTarget (string $value)

- string $value: the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string.

setText (line 58)

Sets the text caption of the hyperlink.

- access: public

void setText (string $value)

- string $value: the text caption to be set

#### Inherited Methods

Inherited From TDataGridColumn

> TDataGridColumn::formatDataValue()
> TDataGridColumn::getDataFieldValue()
> TDataGridColumn::getFooterStyle()
> TDataGridColumn::getFooterText()
> TDataGridColumn::getHeaderImageUrl()
> TDataGridColumn::getHeaderStyle()
> TDataGridColumn::getHeaderText()
> TDataGridColumn::getItemStyle()
> TDataGridColumn::getOwner()
> TDataGridColumn::getSortExpression()
> TDataGridColumn::getViewState()
> TDataGridColumn::getVisible()
> TDataGridColumn::initialize()
> TDataGridColumn::initializeCell()
> TDataGridColumn::loadState()
> TDataGridColumn::saveState()
> TDataGridColumn::setFooterText()
> TDataGridColumn::setHeaderImageUrl()
> TDataGridColumn::setHeaderText()
> TDataGridColumn::setOwner()
> TDataGridColumn::setSortExpression()
> TDataGridColumn::setViewState()
> TDataGridColumn::setVisible()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Documentation generated on Mon, 01 May 2006 23:03:44 -0400 by phpDocumentor 1.3.0RC4