OpenLinkEventArgs Class

Provides data for the RepositoryItemHyperLinkEdit.OpenLink event.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public class OpenLinkEventArgs :
    EventArgs

VB.NET

Public Class OpenLinkEventArgs
    Inherits EventArgs

Related API Members

OpenLinkEventArgs is the data class for the following events:

• HyperLinkEdit.OpenLink
• RecentHyperlinkItem.OpenLink
• RepositoryItemHyperLinkEdit.OpenLink

Remarks

The RepositoryItemHyperLinkEdit.OpenLink event occurs before executing the hyperlink command. The event allows you to modify the command to execute, perform a specific action and cancel default execution.

The command to execute is specified by the OpenLinkEventArgs.EditValue property. This represents an object. The command itself is determined by converting the object to text (the ToString method is called to get the command). You can use this property to modify the command to execute.

If you wish to cancel default execution, set the OpenLinkEventArgs.Handled property to true. By default, the property is false and the editor will will execute the command specified by OpenLinkEventArgs.EditValue after your RepositoryItemHyperLinkEdit.OpenLink event handler.

Inheritance

Object

EventArgs

OpenLinkEventArgs