OpenLinkEventArgs Class

Provides data for the RepositoryItemHyperLinkEdit.OpenLink event.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.1.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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the OpenLinkEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-provide-functionality-for-the-designerverbs-context-links-e3528/CS/Verbs/PropertyVerbsControl.cs#L81

void editor_OpenLink(object sender, DevExpress.XtraEditors.Controls.OpenLinkEventArgs e) {
    (e.EditValue as DesignerVerb).Invoke();

VB.NET

how-to-provide-functionality-for-the-designerverbs-context-links-e3528/VB/Verbs/PropertyVerbsControl.vb#L90

Private Sub editor_OpenLink(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.OpenLinkEventArgs)
    TryCast(e.EditValue, DesignerVerb).Invoke()

Inheritance

Object

EventArgs

OpenLinkEventArgs