Tab
A newer version of this page is available. Switch to the current version.

ASPxHyperLink Class

Represents a text editor with hyperlink functionality.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

Related API Members

The following members accept/return ASPxHyperLink objects:

Remarks

A hyperlink editor presents its contents as a hyperlink. To activate the editor's hyperlink functionality the ASPxHyperLink.NavigateUrl property should be defined which specifies the command to execute when the editor's hyperlink is clicked. The action performed by the ASPxHyperLink editor is determined by the protocol prefix included in the specified URL of the hyperlink. For instance:

  • "http:\www.devexpress.com" - opens the DeveloperExpress, Inc. website. Note, that specifying a website URL without the protocol prefix results in an attempt to open the specified website from the project's folder.
  • "file:///c:\images\blue.bmp" - opens the image located at the specified path.

The ASPxHyperLink.Target property specifies the frame where the hyperlinked document will be displayed.

The content of the editor's hyperlink can be represented by either a caption text or an image. The editor's caption text can be specified by the ASPxHyperLink.Text property. To define an image use the ASPxHyperLink.ImageUrl property which if set has priority over the caption text.

NOTE

The client-side equivalent of this editor control is represented by the ASPxClientHyperLink object. The editor's client-side API is enabled if the ASPxEditBase.EnableClientSideAPI property is set to true, or any client event is handled. Available client events can be accessed via the ASPxStaticEdit.ClientSideEvents property.

See Also