Class \Prado\Web\UI\WebControls\THyperLink

THyperLink class

THyperLink displays a hyperlink on a page. The hyperlink URL is specified via the \Prado\Web\UI\WebControls\setNavigateUrl property, and link text is via the \Prado\Web\UI\WebControls\setText property. It is also possible to display an image by setting the \Prado\Web\UI\WebControls\setImageUrl property. In this case, the style of the image displayed can be set using the \Prado\Web\UI\WebControls\setImageStyle property and \Prado\Web\UI\WebControls\getText is displayed as the alternate text of the image.

The link target is specified via the \Prado\Web\UI\WebControls\setTarget property. If both \Prado\Web\UI\WebControls\getImageUrl and \Prado\Web\UI\WebControls\getText are empty, the content enclosed within the control tag will be rendered.

Class hierarchy

\Prado\Web\UI\WebControls\THyperLink implements IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getData() : string` Returns the URL to link to when the THyperLink component is clicked. This method is required by IDataRenderer. It is the same as getText().
`public deprecated`	`getImageAlign() : string`
`public deprecated`	`getImageHeight() : string`
`public`	`getImageStyle() : TStyle`
`public`	`getImageUrl() : string`
`public deprecated`	`getImageWidth() : string`
`public`	`getNavigateUrl() : string`
`public`	`getTarget() : string`
`public`	`getText() : string`
`public`	`renderContents(THtmlWriter $writer) : mixed` Renders the body content of the hyperlink.
`public`	`setData(string $value) : mixed` Sets the URL to link to when the THyperLink component is clicked. This method is required by IDataRenderer. It is the same as setText().
`public deprecated`	`setImageAlign(string $value) : mixed` Sets the alignment of the image with respective to other elements on the page. Possible values include: absbottom, absmiddle, baseline, bottom, left, middle, right, texttop, and top. If an empty string is passed in, imagealign attribute will not be rendered.
`public deprecated`	`setImageHeight(string $value) : mixed` Sets the height of the image in the THyperLink
`public`	`setImageUrl(string $value) : mixed` Sets the location of image file of the THyperLink.
`public deprecated`	`setImageWidth(string $value) : mixed` Sets the width of the image in the THyperLink
`public`	`setNavigateUrl(string $value) : mixed` Sets the URL to link to when the THyperLink component is clicked.
`public`	`setTarget(string $value) : mixed` Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
`public`	`setText(string $value) : mixed` Sets the text caption of the THyperLink.
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds attributes related to a hyperlink element to renderer.
`protected`	`createImage(string $imageUrl) : TImage` Gets the TImage for rendering the ImageUrl property. This is not for creating dynamic images.
`protected`	`getTagName() : string` Returns the tag name used for this control.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\THyperLink

Class hierarchy