GH_Link

Public Class

Represents a link to another location in the Help or some external address.

Inheritance Hierarchy

System.Object
Grasshopper.Documentation.GH_Link

Namespace: Grasshopper.Documentation

Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public class GH_Link : IGH_Content

The GH_Link type exposes the following members.

Properties

Name

Description

---

Public Property

Destination

Gets the link target.

---

Public Property

IsSharedLink

Gets whether this link is a shared link. A shared link should not have text but it should have a non-empty LinkId.

---

Public Property

LinkId

Gets the link ID. The link ID is only used for shared links.

---

Public Property

Target

Gets the link type.

---

Public Property

Text

Gets the list text.

---

Public Property

Tooltip

Gets the link tooltip text.

---

Methods

Name

Description

---

Public Method
Static Member

CreateExternalLink(String, String)

---

Public Method
Static Member

CreateExternalLink(String, String, String)

---

Public Method
Static Member

CreateGlossaryLink(String)

---

Public Method
Static Member

CreateGlossaryLink(String, String)

---

Public Method
Static Member

CreateSharedLink(String, String)

---

Public Method
Static Member

CreateSharedLink(String, String, String)

---

Public Method
Static Member

CreateTopicLink(String, String)

---

Public Method
Static Member

CreateTopicLink(String, String, String)

---

Public Method

ToString

(Overrides Object.ToString..)

---