Hyperlink Property (AnnObject)

Gets or sets a string which represents the hyperlink for this AnnObject.

Syntax

Visual Basic
C#
Objective-C
Java
C++

public virtual string Hyperlink {get; set;}

'Declaration
 
Public Overridable Property Hyperlink As String

'Usage
 
Dim instance As AnnObject
Dim value As String
 
instance.Hyperlink = value
 
value = instance.Hyperlink

public:
virtual property String^ Hyperlink {
   String^ get();
   void set (    String^ value);
}

Property Value

The hyperlink for this AnnObject.

Remarks

The hyperlink of an object can be any string value or null (Nothing in Visual Basic). It is up to the user application to determine how to use this value.

In automation mode, if the object has a hyperlink and is clicked on at runtime user mode, the automation framework will try to externally execute the hyperlink value. For example, if the hyperlink is an address to a website, a new instance of your internet browser will be created with this hyperlink as the target address. If the hyperlink is a movie file, the default movie player application in your machine will start with this hyperlink value as the movie name and so on.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Annotations
Imports Leadtools.Codecs
Imports Leadtools.WinForms
Imports Leadtools.Drawing

Public Sub AnnObject_Hyperlink(ByVal obj As AnnObject)
   If Not obj.Hyperlink Is Nothing AndAlso obj.Hyperlink <> String.Empty Then
      Try
         System.Diagnostics.Process.Start(obj.Hyperlink)
      Catch ex As Exception
         MessageBox.Show(ex.Message)
      End Try
   End If
End Sub

using Leadtools;
using Leadtools.Annotations;
using Leadtools.Codecs;
using Leadtools.WinForms;
using Leadtools.Drawing;

public void AnnObject_Hyperlink(AnnObject obj)
{
   if(obj.Hyperlink != null && obj.Hyperlink != string.Empty)
   {
      try
      {
         System.Diagnostics.Process.Start(obj.Hyperlink);
      }
      catch(Exception ex)
      {
         MessageBox.Show(ex.Message);
      }
   }
}

Requirements

Target Platforms

Reference

AnnObject Class
AnnObject Members