Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Collapse]DevExpress.XtraEditors
   [Expand]AreaChartRangeControlClientView Class
   [Expand]BarCodeControl Class
   [Expand]BaseButton Class
   [Expand]BaseCheckEdit Class
   [Expand]BaseCheckedListBoxControl Class
   [Expand]BaseControl Class
   [Expand]BaseDateControl Class
   [Expand]BaseEdit Class
   [Expand]BaseImageListBoxControl Class
   [Expand]BaseListBoxControl Class
   [Expand]BaseSpinEdit Class
   [Expand]BaseStyleControl Class
   [Expand]BlobBaseEdit Class
   [Expand]BreadCrumbEdit Class
   [Expand]BreadCrumbHistory Class
   [Expand]BreadCrumbHistoryItem Class
    BreadCrumbMode Enumeration
   [Expand]BreadCrumbNode Class
   [Expand]BreadCrumbNodeCollection Class
   [Expand]ButtonEdit Class
   [Expand]CalcEdit Class
   [Expand]ChartRangeControlClientBase Class
   [Expand]ChartRangeControlClientDataProvider Class
   [Expand]ChartRangeControlClientGridOptions Class
   [Expand]ChartRangeControlClientRange Class
   [Expand]ChartRangeControlClientView Class
   [Expand]CheckButton Class
   [Expand]CheckedComboBoxEdit Class
   [Expand]CheckEdit Class
   [Expand]CheckedListBoxControl Class
   [Expand]ClientDataSourceProviderCustomizeSeriesEventArgs Class
   [Expand]ColorDialogOptions Class
   [Expand]ColorEdit Class
   [Expand]ColorPickEdit Class
   [Expand]ColorPickEditBase Class
   [Expand]ColorPickEditTooltipShowingEventArgs Class
    ColorTooltipFormat Enumeration
   [Expand]ComboBox Class
   [Expand]ComboBoxEdit Class
   [Expand]ControlNavigator Class
   [Expand]ControlNavigatorButtonCollection Class
   [Expand]ControlNavigatorButtons Class
   [Expand]DataNavigator Class
   [Expand]DataNavigatorButtonCollection Class
   [Expand]DataNavigatorButtons Class
   [Expand]DateControl Class
   [Expand]DateEdit Class
   [Expand]DateTimeChartRangeControlClient Class
   [Expand]DateTimeChartRangeControlClientGridOptions Class
   [Expand]DateTimeChartRangeControlClientRange Class
    DropDownArrowStyle Enumeration
   [Expand]DropDownButton Class
   [Expand]FilterControl Class
    FilterEditorViewMode Enumeration
    FindMode Enumeration
   [Expand]FontEdit Class
    FormatCondition Enumeration
    FormatConditionAboveBelowType Enumeration
    FormatConditionAutomaticType Enumeration
   [Expand]FormatConditionCollectionBase Class
    FormatConditionComparisonType Enumeration
   [Expand]FormatConditionIconSet Class
   [Expand]FormatConditionIconSetIcon Class
   [Expand]FormatConditionRule2ColorScale Class
   [Expand]FormatConditionRule3ColorScale Class
   [Expand]FormatConditionRuleAboveBelowAverage Class
   [Expand]FormatConditionRuleAppearanceBase Class
   [Expand]FormatConditionRuleBase Class
    FormatConditionRuleChangeType Enumeration
   [Expand]FormatConditionRuleContains Class
   [Expand]FormatConditionRuleDataBar Class
   [Expand]FormatConditionRuleDateOccuring Class
   [Expand]FormatConditionRuleExpression Class
   [Expand]FormatConditionRuleIconSet Class
   [Expand]FormatConditionRuleMinMaxBase Class
   [Expand]FormatConditionRuleTopBottom Class
   [Expand]FormatConditionRuleUniqueDuplicate Class
   [Expand]FormatConditionRuleValue Class
    FormatConditionTopBottomType Enumeration
    FormatConditionUniqueDuplicateType Enumeration
    FormatConditionValueType Enumeration
   [Expand]FormatRuleBase Class
    FormBorderEffect Enumeration
   [Expand]GridLookUpEdit Class
   [Expand]GridLookUpEditBase Class
   [Expand]GroupCaptionCustomDrawEventArgs Class
    GroupCaptionCustomDrawEventHandler Delegate
   [Expand]GroupControl Class
    HighlightStyle Enumeration
    HotTrackSelectMode Enumeration
   [Expand]HScrollBar Class
   [Expand]HScrollBarBase Class
   [Expand]HyperLinkEdit Class
   [Collapse]HyperlinkLabelControl Class
     HyperlinkLabelControl Members
     HyperlinkLabelControl Constructor
    [Expand]HyperlinkLabelControl Properties
   [Expand]HyperlinkLabelControlAppearanceObject Class
   [Expand]HyperlinkLabelControlAppearanceOptions Class
    ImageAlignToText Enumeration
   [Expand]ImageComboBoxEdit Class
   [Expand]ImageEdit Class
   [Expand]ImageListBoxControl Class
    ImageLocation Enumeration
    LabelAutoSizeMode Enumeration
   [Expand]LabelControl Class
   [Expand]LabelControlAppearanceObject Class
   [Expand]LineChartRangeControlClientView Class
   [Expand]ListBoxControl Class
   [Expand]ListBoxDrawItemEventArgs Class
    ListBoxDrawItemEventHandler Delegate
   [Expand]LookUpEdit Class
   [Expand]LookUpEditBase Class
   [Expand]MarqueeProgressBarControl Class
   [Expand]MemoEdit Class
   [Expand]MemoExEdit Class
   [Expand]MRUEdit Class
   [Expand]NavigatorBase Class
   [Expand]NavigatorButton Class
   [Expand]NavigatorButtonBase Class
   [Expand]NavigatorButtonClickEventArgs Class
    NavigatorButtonClickEventHandler Delegate
   [Expand]NavigatorButtonCollectionBase Class
   [Expand]NavigatorButtonsBase Class
    NavigatorButtonsTextLocation Enumeration
    NavigatorButtonType Enumeration
   [Expand]NavigatorCustomButton Class
   [Expand]NavigatorCustomButtons Class
   [Expand]NavigatorExceptionEventArgs Class
    NavigatorExceptionEventHandler Delegate
   [Expand]NumericChartRangeControlClient Class
   [Expand]NumericChartRangeControlClientGridOptions Class
   [Expand]NumericChartRangeControlClientRange Class
   [Expand]NumericRangeControlClient Class
   [Expand]PanelControl Class
   [Expand]PickImage Class
   [Expand]PictureEdit Class
   [Expand]PopupBaseAutoSearchEdit Class
   [Expand]PopupBaseEdit Class
    PopupCloseMode Enumeration
   [Expand]PopupContainerControl Class
   [Expand]PopupContainerEdit Class
    PopupFilterMode Enumeration
   [Expand]PopupGalleryEdit Class
   [Expand]PopupGalleryEditGallery Class
   [Expand]PopupPanelOptions Class
   [Expand]ProgressBarBaseControl Class
   [Expand]ProgressBarControl Class
   [Expand]RadioGroup Class
   [Expand]RangeControl Class
   [Expand]RangeControlClientBase Class
    RangeControlDateTimeGridAlignment Enumeration
   [Expand]RangeTrackBarControl Class
   [Expand]RatingControl Class
   [Expand]ScrollBarBase Class
    ScrollBarType Enumeration
    ScrollUIMode Enumeration
   [Expand]SearchControl Class
   [Expand]SearchLookUpEdit Class
   [Expand]SeparatorControl Class
   [Expand]SidePanel Class
   [Expand]SimpleButton Class
   [Expand]SimpleControl Class
   [Expand]SparklineEdit Class
   [Expand]SpinEdit Class
   [Expand]SplitContainerControl Class
    SplitFixedPanel Enumeration
    SplitPanelVisibility Enumeration
   [Expand]SplitterControl Class
   [Expand]StyleController Class
   [Expand]StyleFormatConditionBase Class
   [Expand]TextEdit Class
   [Expand]TileControl Class
    TileControlImageToTextAlignment Enumeration
    TileControlScrollMode Enumeration
   [Expand]TileGroup Class
   [Expand]TileGroupCollection Class
   [Expand]TileItem Class
   [Expand]TileItemAppearances Class
    TileItemCheckMode Enumeration
    TileItemClickEventHandler Delegate
   [Expand]TileItemCollection Class
    TileItemContentAlignment Enumeration
   [Expand]TileItemDragEventArgs Class
    TileItemDragEventHandler Delegate
   [Expand]TileItemElement Class
   [Expand]TileItemElementCollection Class
   [Expand]TileItemEventArgs Class
   [Expand]TileItemFrame Class
   [Expand]TileItemFrameCollection Class
    TileItemImageScaleMode Enumeration
    TileItemSize Enumeration
   [Expand]TimeEdit Class
   [Expand]TimeSpanEdit Class
   [Expand]ToggleSwitch Class
   [Expand]TokenEdit Class
   [Expand]TrackBarControl Class
   [Expand]TreeListLookUpEdit Class
    VistaCalendarViewStyle Enumeration
   [Expand]VScrollBar Class
   [Expand]VScrollBarBase Class
    WaitAnimationOptions Enumeration
   [Expand]WindowsFormsSettings Class
   [Expand]XtraDialog Class
   [Expand]XtraFolderBrowserDialog Class
   [Expand]XtraForm Class
   [Expand]XtraInputBox Class
   [Expand]XtraInputBoxArgs Class
   [Expand]XtraMessageBox Class
   [Expand]XtraOpenFileDialog Class
   [Expand]XtraPanel Class
   [Expand]XtraSaveFileDialog Class
   [Expand]XtraScrollableControl Class
   [Expand]XtraUserControl Class
   [Expand]ZoomTrackBarControl Class
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

HyperlinkLabelControl Class

The label that supports displaying text or its portion as a hyperlink. Allows you to use HTML tags to format text.

Namespace:DevExpress.XtraEditors
Assembly:DevExpress.XtraEditors.v17.2.dll

Expanded Syntax

Expanded Remarks

The HyperlinkLabelControl allows displaying all its text or part of it as a hyperlink.

If you specify the control's Text property as an ordinary string, the entire text is considered and displayed as a hyperlink.

To show a part of text as a hyperlink, format this substring with the <href></href> tag. You can also add multiple hyperlinks to the control's text using this tag.

Note

In the HyperlinkLabelControl, HTML formatting is always allowed. So, you can use other HTML tags (for instance, <color>, <b>, <size>, <br>, etc.) to format the control's text. See the HTML Text Formatting document for more information.

By default, no actions are performed when an end-user clicks hyperlinks. To process a specific hyperlink or perform other desired actions, handle the HyperlinkLabelControl's LabelControl.HyperlinkClick event.

The following table lists the available states of hyperlinks, and properties affecting the link appearance in corresponding states.

Link State Appearance Property Comments
Normal HyperlinkLabelControlAppearanceObject.LinkColor -
Pressed HyperlinkLabelControlAppearanceObject.PressedColor -
Hovered - Use the LinkBehavior property to specify when links should be underlined (always, never, when the mouse is hovered over links, etc.).
Visited HyperlinkLabelControlAppearanceObject.VisitedColor By default, the control does not mark links as visited links when an end-user clicks them. However, you can manually mark all links as visited links by setting the LinkVisited property to true (for instance, in the HyperlinkClick event handler). Visited links will be highlighted in the corresponding color.
Disabled HyperlinkLabelControlAppearanceObject.DisabledColor Hyperlinks are in the disabled state if the control's Enabled property is set to false.

Since the HyperlinkLabelControl class is derived from the LabelControl class, it inherits all the label control's features, such as the capability to display regular and animated images, the alignment of images relative to the control's text, a horizontal line within the control's empty space, etc. See the LabelControl class description to learn more.

To format text using HTML syntax in cells in container controls (e.g., Data Grid, Tree List, etc.), use the RepositoryItemHypertextLabel in-place editor.

Expanded Example

The following code demonstrates how to use the HyperlinkLabelControl class.

This example creates a HyperlinkLabelControl displaying two hyperlinks. Hyperlinks are inserted to the control's text (Text property) using the <href></href> tag. The HyperlinkClick event handler opens the clicked link in the Web browser, and marks all links as visited links.

To underline links only when the mouse is hovered over them, the LinkBehavior property is set to HoverUnderline. The HyperlinkLabelControlAppearanceObject.LinkColor, HyperlinkLabelControlAppearanceObject.PressedColor and HyperlinkLabelControlAppearanceObject.VisitedColor properties specify the colors used to paint hyperlinks in various states.

Expanded Inheritance Hierarchy

System.Object
    System.MarshalByRefObject
       System.ComponentModel.Component
          System.Windows.Forms.Control
             ControlBase
                BaseControl
                   BaseStyleControl
                      LabelControl
                         HyperlinkLabelControl

Expanded See Also

How would you rate this topic?​​​​​​​