←Select platform

Hyperlink Property

Summary

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

Syntax

C#
VB
C++
public virtual string Hyperlink { get; set; } 
  
Public Overridable Property Hyperlink As String 
public: 
virtual property String^ Hyperlink { 
   String^ get(); 
   void set (    String^ ); 
} 

Property Value

The hyperlink for this AnnObject.

Remarks

The hyperlink of an object can be any string value or null (Nothing in VB). 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

This method will "run" the object hypelink manually.

C#
VB
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); 
      } 
   } 
} 
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 

Requirements

Target Platforms

See Also

Reference

AnnObject Class

AnnObject Members

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations Assembly