Tekla Open API

Detailed and full API reference helps you master Tekla Open API

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

HyperLink Class

The HyperLink class defines a hyperlink object in a drawing. When a hyperlink is double clicked, the default browser is launched.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Drawing
Assembly:  Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2018.1.0.0 (2018.1.0.0)
Syntax
[SerializableAttribute]
public sealed class HyperLink : LinkBase

The HyperLink type exposes the following members.

Constructors
  Name Description
Public method HyperLink(ViewBase, Point, Uri, String)
Creates a new hyperlink instance using standard attributes.
Public method HyperLink(ViewBase, Point, Uri, String, LinkAttributes)
Creates a new hyperlink instance using the given attributes.
Public method HyperLink(ViewBase, Point, Uri, String, Size)
Creates a new hyperlink instance using standard attributes.
Public method HyperLink(ViewBase, Point, Uri, String, Size, LinkAttributes)
Creates a new hyperlink instance using the given attributes.
Top
Properties
  Name Description
Public property Angle
Gets or sets the angle of the link.
(Inherited from LinkBase.)
Public property Attributes
Gets or sets the link attributes.
(Inherited from LinkBase.)
Public property InsertionPoint
Gets or sets the insertion point of the link.
(Inherited from LinkBase.)
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public property Target
Gets or sets the target.
Public property Text
Gets or sets the link text that is visible on the screen.
(Inherited from LinkBase.)
Top
Methods
  Name Description
Public method Delete
Deletes the link.
(Overrides DatabaseObjectDelete.)
Public method GetAxisAlignedBoundingBox
Gets the bounding box for the current object in the global axis coordinate system.
(Inherited from LinkBase.)
Public method GetDoubleUserProperties(DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetDoubleUserProperties(ListString, DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetDrawing
Gets the drawing where the drawing object is.
(Inherited from DrawingObject.)
Public method GetIntegerUserProperties(DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetIntegerUserProperties(ListString, DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetObjectAlignedBoundingBox
Gets the bounding box for the current object in its local coordinate system.
(Inherited from LinkBase.)
Public method GetRelatedObjects
Gets the related objects of the current object.
(Inherited from DrawingObject.)
Public method GetRelatedObjects(Type)
Gets the related objects of the current object that are of certain types.
(Inherited from DrawingObject.)
Public method GetStringUserProperties(DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetStringUserProperties(ListString, DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Double)
Gets a double property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Int32)
Gets an integer property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, String)
Gets a string property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetView
Gets the view where the drawing object is.
(Inherited from DrawingObject.)
Public method Insert
Inserts the link.
(Overrides DatabaseObjectInsert.)
Public method IsEqual
Compares the current object with an object of the same type.
(Overrides DrawingObjectIsEqual(Object).)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from DatabaseObject.)
Public method Modify
Modifies the link.
(Overrides DatabaseObjectModify.)
Public method MoveObjectRelative
Moves the object according to the given move vector.
(Inherited from LinkBase.)
Public method Resize
Resizes the object. The scaling type is changed to ScaleToFit.
(Inherited from LinkBase.)
Public method Select
Selects the link.
(Overrides DatabaseObjectSelect.)
Public method SetUserProperty(String, Double)
Sets a double property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, Int32)
Sets an integer property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, String)
Sets a string property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method ToString
Changes the string presentation of the drawing object.
(Inherited from DrawingObject.)
Top
Examples
The following example shows how to insert a hyperlink:
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;
using System;

public class Example
{
       public void Example1()
       {
           DrawingHandler MyDrawingHandler = new DrawingHandler();
           ViewBase _view = MyDrawingHandler.GetActiveDrawing().GetSheet().GetAllViews().Current as ViewBase;

           HyperLink link = new HyperLink(_view, new Point(200, 200),
               new Uri("http://www.tekla.com"),
               "Link to Tekla home page");
           link.Insert();
       }
}
See Also