SpreadsheetHyperlink Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Hyperlink class.

public sealed class SpreadsheetHyperlink
Public NotInheritable Class SpreadsheetHyperlink
Inheritance:
System.Object
SpreadsheetHyperlink

Properties

If hyperlink exists returns true, otherwise returns false.

public bool Exists { get; }
Public ReadOnly Property Exists As Boolean
Property Value
System.Boolean

Defines if hyperlink location is in this excel file.

public bool IsExternal { get; set; }
Public Property IsExternal As Boolean
Property Value
System.Boolean

Gets or sets the location string for hyperlink.URL has to be in escaped format (you can use System.Uri.EscapeUriString(System.String) method).

public string Location { get; set; }
Public Property Location As String
Property Value
System.String

Gets or sets ToolTip for hyperlink.

public string ToolTip { get; set; }
Public Property ToolTip As String
Property Value
System.String

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this SpreadsheetHyperlink instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this SpreadsheetHyperlink instance.

Returns
System.Boolean

true if the specified System.Object is a SpreadsheetHyperlink and is equal to this SpreadsheetHyperlink instance; otherwise, false.

Overrides
System.Object.Equals(System.Object)

Returns a hash code for this SpreadsheetHyperlink instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this SpreadsheetHyperlink instance.

Overrides
System.Object.GetHashCode()

Operators

Equality(SpreadsheetHyperlink, SpreadsheetHyperlink)

Determines whether first and second SpreadsheetHyperlinks are equal.

public static bool operator ==(SpreadsheetHyperlink first, SpreadsheetHyperlink second)
Public Shared Operator =(first As SpreadsheetHyperlink, second As SpreadsheetHyperlink) As Boolean
Parameters
first
SpreadsheetHyperlink
second
SpreadsheetHyperlink
Returns
System.Boolean

true if first and second SpreadsheetHyperlinks are equal; otherwise, false.

Inequality(SpreadsheetHyperlink, SpreadsheetHyperlink)

Determines whether first and second SpreadsheetHyperlinks are not equal.

public static bool operator !=(SpreadsheetHyperlink first, SpreadsheetHyperlink second)
Public Shared Operator <>(first As SpreadsheetHyperlink, second As SpreadsheetHyperlink) As Boolean
Parameters
first
SpreadsheetHyperlink
second
SpreadsheetHyperlink
Returns
System.Boolean

true if first and second SpreadsheetHyperlinks are not equal; otherwise, false.