Class: THyperLink

Source Location: /Web/UI/WebControls/THyperLink.php

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --THyperLink

THyperLink class

Class Details

[line 52]
THyperLink class

THyperLink displays displays a hyperlink to another Web page.

The THyperLink component is typically displayed as text specified by the Text property. If an image is specified by the ImageUrl property, the image will be displayed and the Text is shown as a tooltip of the image.alternative image text. If both Text and ImageUrl are empty, the content enclosed in the body of the THyperLink component will be displayed.

Note, Text will be HTML encoded before it is displayed in the THyperLink component. If you don't want it to be so, set EncodeText to false.

Namespace: System.Web.UI.WebControls

Properties

Text, string, kept in viewstate
Gets or sets the text caption for the THyperLink component.
EncodeText, boolean, default=true, kept in viewstate
Gets or sets the value indicating whether Text should be HTML-encoded when rendering.
NavigateUrl, string, kept in viewstate
Gets or sets the URL to link to when the THyperLink component is clicked.
Target, string, kept in viewstate
Gets or sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked. Valid values include '_blank', '_parent', '_self', '_top', and empty string.
ImageUrl, string, kept in viewstate
Gets or sets the location of an image to display in the THyperLink component.

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

constructor __construct [line 58]

THyperLink __construct(
)

Constructor.

Sets TagName property to 'a'.

access:

public

Overrides TControl::__construct() (Constructor.)

[ Top ]

method getAttributesToRender [line 153]

ArrayObject getAttributesToRender(
)

This overrides the parent implementation by rendering more THyperLink-specific attributes.

return:	the attributes to be rendered
access:	protected

Overrides TWebControl::getAttributesToRender() (This overrides the parent implementation by rendering more TWebControl-specific attributes.)

[ Top ]

method getImageUrl [line 101]

string getImageUrl(
)

return:	the location of the image file for the THyperLink
access:	public

[ Top ]

method getNavigateUrl [line 118]

string getNavigateUrl(
)

return:	the URL to link to when the THyperLink component is clicked.
access:	public

[ Top ]

method getTarget [line 135]

string getTarget(
)

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

[ Top ]

method getText [line 67]

string getText(
)

return:	the text caption of the THyperLink
access:	public

[ Top ]

method isEncodeText [line 84]

boolean isEncodeText(
)

return:	whether the text should be HTML encoded before rendering
access:	public

[ Top ]

method renderBody [line 165]

void renderBody(
)

access:

protected

Overrides TControl::renderBody() (Renders the body content.)

[ Top ]

method setEncodeText [line 93]

void setEncodeText(
boolean
$value)

Sets the value indicating whether the text should be HTML encoded before rendering

access:

public

Parameters:

boolean

$value

whether the text should be HTML encoded before rendering

[ Top ]

method setImageUrl [line 110]

void setImageUrl(
string
$value)

Sets the location of image file of the THyperLink.

access:

public

Parameters:

string

$value

the image file location

[ Top ]

method setNavigateUrl [line 127]

void setNavigateUrl(
string
$value)

Sets the URL to link to when the THyperLink component is clicked.

access:

public

Parameters:

string

$value

the URL

[ Top ]

method setTarget [line 144]

void setTarget(
string
$value)

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

access:

public

Parameters:

string

$value

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

[ Top ]

method setText [line 76]

void setText(
string
$value)

Sets the text caption of the THyperLink.

access:

public

Parameters:

string

$value

the text caption to be set

[ Top ]