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
  [Expand]DevExpress.XtraEditors
  [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
  [Collapse]DevExpress.XtraEditors.Repository
   [Expand]BaseRepositoryItemCheckEdit Class
    CalendarSelectionMode Enumeration
    CalendarView Enumeration
   [Expand]EditorsRepositoryBase Class
    ExportMode Enumeration
    GridLookUpViewType Enumeration
   [Expand]PersistentRepository Class
   [Expand]RepositoryItem Class
   [Expand]RepositoryItemBaseProgressBar Class
   [Expand]RepositoryItemBaseSpinEdit Class
   [Expand]RepositoryItemBlobBaseEdit Class
   [Expand]RepositoryItemBreadCrumbEdit Class
   [Expand]RepositoryItemButtonEdit Class
   [Expand]RepositoryItemCalcEdit Class
   [Expand]RepositoryItemCheckedComboBoxEdit Class
   [Expand]RepositoryItemCheckEdit Class
   [Expand]RepositoryItemCollection Class
   [Expand]RepositoryItemColorEdit Class
   [Expand]RepositoryItemColorPickEdit Class
   [Expand]RepositoryItemComboBox Class
   [Expand]RepositoryItemDateEdit Class
   [Expand]RepositoryItemFontEdit Class
   [Expand]RepositoryItemGridLookUpEdit Class
   [Expand]RepositoryItemGridLookUpEditBase Class
   [Collapse]RepositoryItemHyperLinkEdit Class
     RepositoryItemHyperLinkEdit Members
     RepositoryItemHyperLinkEdit Constructor
    [Expand]RepositoryItemHyperLinkEdit Properties
    [Collapse]RepositoryItemHyperLinkEdit Events
      OpenLink Event
    [Expand]RepositoryItemHyperLinkEdit Methods
   [Expand]RepositoryItemHypertextLabel Class
   [Expand]RepositoryItemImageComboBox Class
   [Expand]RepositoryItemImageEdit Class
   [Expand]RepositoryItemLookUpEdit Class
   [Expand]RepositoryItemLookUpEditBase Class
   [Expand]RepositoryItemMarqueeProgressBar Class
   [Expand]RepositoryItemMemoEdit Class
   [Expand]RepositoryItemMemoExEdit Class
   [Expand]RepositoryItemMRUEdit Class
   [Expand]RepositoryItemPageNumberEdit Class
   [Expand]RepositoryItemPickImage Class
   [Expand]RepositoryItemPictureEdit Class
   [Expand]RepositoryItemPopupBase Class
   [Expand]RepositoryItemPopupBaseAutoSearchEdit Class
   [Expand]RepositoryItemPopupContainerEdit Class
   [Expand]RepositoryItemPopupGalleryEdit Class
   [Expand]RepositoryItemProgressBar Class
   [Expand]RepositoryItemRadioGroup Class
   [Expand]RepositoryItemRangeTrackBar Class
   [Expand]RepositoryItemRatingControl Class
   [Expand]RepositoryItemRichTextEdit Class
   [Expand]RepositoryItemSearchControl Class
   [Expand]RepositoryItemSearchLookUpEdit Class
   [Expand]RepositoryItemSparklineEdit Class
   [Expand]RepositoryItemSpinEdit Class
   [Expand]RepositoryItemTextEdit Class
   [Expand]RepositoryItemTimeEdit Class
   [Expand]RepositoryItemTimeSpanEdit Class
   [Expand]RepositoryItemToggleSwitch Class
   [Expand]RepositoryItemTokenEdit Class
   [Expand]RepositoryItemTrackBar Class
   [Expand]RepositoryItemTreeListLookUpEdit Class
   [Expand]RepositoryItemZoomTrackBar Class
   [Expand]RichTextEditBehaviorOptions Class
   [Expand]RichTextEditHorizontalScrollbarOptions Class
    TimeEditStyle Enumeration
   [Expand]TrackBarRange Structure
  [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

RepositoryItemHyperLinkEdit.OpenLink Event

Occurs before hyperlink execution.

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

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type OpenLinkEventArgs containing data related to this event.

The following OpenLinkEventArgs properties provide information specific to this event.
Property Description
EditValue Gets or sets the object representing the command to execute.
Handled Gets or sets whether default execution of the hyperlink command is required.

Expanded Remarks

The OpenLink event is fired before hyperlink execution. The event allows you to modify the command to execute, perform your action(s) and cancel default processing (if necessary).

The event occurs when the end-user activates hyperlink functionality or when the HyperLinkEdit.ShowBrowser method is called. It is possible to execute the hyperlink command by clicking or double-clicking the edit box (according to the SingleClick property) and by pressing the StartKey shortcut.

The sender event parameter specifies the hyperlink editor which fires the event. The second event parameter contains data related to the event.

OpenLinkEventArgs.EditValue specifies the value of the editor's BaseEdit.EditValue property. This represents the command to execute. You are able to modify the command depending on your needs. After running your OpenLink event handler, the editor will execute this command unless the OpenLinkEventArgs.Handled property has been set to true, to prevent the default command execution.

The editor's HyperLinkEdit.OpenLink event is equivalent to the current event.

Expanded Example

Suppose that a hyperlink editor is used to display e-mails. When you activate the hyperlink, the default mail client should be opened for the specified address. The problem is that a hyperlink editor will run the mail client only if the command contains a "mailto:" prefix. So a command such as "support@devexpress.com" is not recognized by the editor by default.

Assuming that the hyperlink editor represents e-mails, we handle the HyperLinkEdit.OpenLink event and check whether the command contains the "mailto:" prefix. If not, we add it to the command. After the event handler is processed, the command will be executed by the editor (the OpenLinkEventArgs.Handled property of the event parameter is false by default) and this will open the mail client.

Expanded See Also

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