TDrawingHyperlink Record
Specifies an hyperlink in a drawing. While this class is similar to THyperlink for links in cells, it has some differences.
Syntax
Unit: FlexCel.Core
TDrawingHyperlink = record;Methods
| Name | Description |
|---|---|
| Create | Overloaded Create Create(string, string, string, string, Boolean, Boolean, Boolean) Create(string, string, string, string, string, Boolean, Boolean, Boolean) |
| Null | Returns an empty instance. |
| CompareTo | Returns -1, 0 or 1 depending if this object is smaller or bigger than the other. |
| GetHashCode | Returns the hashcode of the object. |
| Equals | Returns true if both instances have the same data. |
| CloneLink | Returns a deep clone of source. |
| GetLinkType | Returns the type of hyperlink. |
| IsNull | Returns true if the record doesn't have a defined value. |
| HasValue | Returns true if the record has a defined value. This is the inverse of IsNull |
Operators
| Name | Description |
|---|---|
| Equality | Adapts the = operator so it returns true when both instances have the same values. |
| Inequality | Adapts the <> operator so it returns true when both instances have different values. |
| Implicit Conversion | Overloaded Implicit conversion from TDrawingHyperlink to THyperLink Implicit conversion from THyperLink to TDrawingHyperlink Implicit conversion from TNull to TDrawingHyperlink |
Properties
| Name | Description |
|---|---|
| Url | Url for the link (including the prefix like "file:///"). Note that if the file has a BaseUrl, the final URL is given by FullUrl |
| BaseUrl | Base URL that will be added to the start of Url if it is set in the file. The property FullUrl contains the combined URL. |
| FullUrl | Returns BaseUrl combined with Url when Url is not an absolute Uri. |
| TargetFrame | If blank then a new window will be used. |
| Hint | Tooltip to show when the user hovers over the hyperlink. |
| Action | Specifies an action that is to be taken when this hyperlink is activated. This can be used to specify a slide to be navigated to or a script of code to be run. Doesn't seem to be used in Excel. |
| HighlightClick | When set to true, the link will be painted in a "Visited" color. |
| AddToHistory | If true, the link will be added to the history. |
| EndsSounds | If true, any sound currently playing will be stopped when you click the link. |