Class THyperLink
Direct Known Sub-classes:
THyperLink class
THyperLink displays a hyperlink on a page. The hyperlink URL is specified via the NavigateUrl property, and link text is via the Text property. It is also possible to display an image by setting the ImageUrl property. In this case, Text is displayed as the alternate text of the image. The link target is specified via the Target property. If both ImageUrl and Text are empty, the content enclosed within the control tag will be rendered.
Constants Inherited From TControl |
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
Method Summary |
protected
void
|
Adds attributes related to a hyperlink element to renderer.
|
protected
TImage
|
Gets the TImage for rendering the ImageUrl property. This is not for creating dynamic images.
|
string
|
Returns the URL to link to when the THyperLink component is clicked.
|
string
|
|
string
|
|
protected
string
|
|
string
|
|
string
|
|
void
|
Renders the body content of the hyperlink.
|
void
|
Sets the URL to link to when the THyperLink component is clicked.
|
void
|
Sets the location of image file of the THyperLink.
|
void
|
Sets the URL to link to when the THyperLink component is clicked.
|
void
|
Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
|
void
|
Sets the text caption of the THyperLink.
|
Methods Inherited From TWebControl |
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
Methods Inherited From TControl |
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Method Details |
addAttributesToRender
protected void addAttributesToRender |
(THtmlWriter $writer ) |
Adds attributes related to a hyperlink element to renderer.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
createImage
protected TImage createImage |
(string $imageUrl ) |
Gets the TImage for rendering the ImageUrl property. This is not for creating dynamic images.
Input |
string | $imageUrl | image url. |
Output |
TImage
| image control for rendering. |
Exception |
|
getData
Returns the URL to link to when the THyperLink component is clicked.
This method is required by IDataRenderer. It is the same as getText().
Output |
string
| the text caption |
Exception |
|
getImageUrl
public string getImageUrl |
() |
Output |
string
| the location of the image file for the THyperLink |
Exception |
|
getNavigateUrl
public string getNavigateUrl |
() |
Output |
string
| the URL to link to when the THyperLink component is clicked. |
Exception |
|
getTagName
protected string getTagName |
() |
Output |
string
| tag name of the hyperlink |
Exception |
|
getTarget
public string getTarget |
() |
Output |
string
| the target window or frame to display the Web page content linked to when the THyperLink component is clicked. |
Exception |
|
getText
Output |
string
| the text caption of the THyperLink |
Exception |
|
renderContents
Renders the body content of the hyperlink.
Input |
THtmlWriter | $writer | the writer for rendering |
Output |
Exception |
|
setData
public void setData |
(string $value ) |
Sets the URL to link to when the THyperLink component is clicked.
This method is required by IDataRenderer. It is the same as setText().
Input |
string | $value | the text caption to be set |
Output |
Exception |
|
setImageUrl
public void setImageUrl |
(string $value ) |
Sets the location of image file of the THyperLink.
Input |
string | $value | the image file location |
Output |
Exception |
|
setNavigateUrl
public void setNavigateUrl |
(string $value ) |
Sets the URL to link to when the THyperLink component is clicked.
Input |
string | $value | the URL |
Output |
Exception |
|
setTarget
public void setTarget |
(string $value ) |
Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
Input |
string | $value | the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string. |
Output |
Exception |
|
setText
public void setText |
(string $value ) |
Sets the text caption of the THyperLink.
Input |
string | $value | the text caption to be set |
Output |
Exception |
|
|