Leadtools.Annotations Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
Hyperlink Property
See Also  Example
Leadtools.Annotations Namespace > AnnObject Class : Hyperlink Property




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

Syntax

Visual Basic (Declaration) 
Public Overridable Property Hyperlink As String
Visual Basic (Usage)Copy Code
Dim instance As AnnObject
Dim value As String
 
instance.Hyperlink = value
 
value = instance.Hyperlink
C# 
public virtual string Hyperlink {get; set;}
Managed Extensions for C++ 
public: __property virtual string* get_Hyperlink();
public: __property virtual void set_Hyperlink( 
   string* value
);
C++/CLI 
public:
virtual property String^ Hyperlink {
   String^ get();
   void set (String^ value);
}

Return Value

The hyperlink for this AnnObject.

Example

This method will "run" the object hypelink manually.

Visual BasicCopy Code
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
C#Copy Code
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); 
      } 
   } 
}

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Leadtools.Annotations requires a Document or Medical toolkit license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features