Class HyperlinkInfo

Immutable descriptor for hyperlink targets, including URL, email, and in-document addresses with optional screen tips.

Inheritance
System.Object
HyperlinkInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class HyperlinkInfo

Properties

Address

Gets the primary target address (URL, email address, or empty for in-document links).

Declaration
public string Address { get; }
Property Value
System.String

The address.

EmailSubject

Gets the email subject line used when Type is Mailto.

Declaration
public string EmailSubject { get; }
Property Value
System.String

The email subject.

ScreenTip

Gets the tooltip text displayed when hovering over the hyperlink.

Declaration
public string ScreenTip { get; }
Property Value
System.String

The screen tip.

SubAddress

Gets the in-document target (sheet name and range) used when Type is InDocument.

Declaration
public string SubAddress { get; }
Property Value
System.String

The sub address.

Type

Gets the hyperlink category (Url, Mailto, or InDocument).

Declaration
public HyperlinkType Type { get; }
Property Value
HyperlinkType

The type.

Methods

CreateHyperlink(String, String)

Creates a URL hyperlink with the specified web or file address and optional screen tip.

Declaration
public static HyperlinkInfo CreateHyperlink(string address, string screenTip = null)
Parameters
System.String address

The address.
System.String screenTip

The screen tip.
Returns
HyperlinkInfo

The hyperlink information.

CreateInDocumentHyperlink(String, String)

Creates a hyperlink navigating to a worksheet location within the same workbook (e.g., "Sheet1!A1:B5").

Declaration
public static HyperlinkInfo CreateInDocumentHyperlink(string subAddress, string screenTip = null)
Parameters
System.String subAddress

The sub address.
System.String screenTip

The screen tip.
Returns
HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(String)

Creates an email hyperlink for the specified address.

Declaration
public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress)
Parameters
System.String emailAddress

The email address.
Returns
HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(String, String)

Creates an email hyperlink with the specified address and subject line.

Declaration
public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress, string emailSubject)
Parameters
System.String emailAddress

The email address.
System.String emailSubject

The email subject.
Returns
HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(String, String, String)

Creates an email hyperlink with the specified address, subject line, and screen tip.

Declaration
public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress, string emailSubject, string screenTip)
Parameters
System.String emailAddress

The email address.
System.String emailSubject

The email subject.
System.String screenTip

The screen tip.
Returns
HyperlinkInfo

The hyperlink information.

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Extension Methods