New to Telerik Document Processing? Start a free 30-day trial

HyperlinkInfo

Class

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class HyperlinkInfo

Inheritance: objectHyperlinkInfo

Methods

CreateHyperlink(string, string)

HyperlinkInfo

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

public static HyperlinkInfo CreateHyperlink(string address, string screenTip = null)

Parameters:addressstring

The address.

screenTipstring

The screen tip.

Returns:

HyperlinkInfo

The hyperlink information.

CreateInDocumentHyperlink(string, string)

HyperlinkInfo

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

public static HyperlinkInfo CreateInDocumentHyperlink(string subAddress, string screenTip = null)

Parameters:subAddressstring

The sub address.

screenTipstring

The screen tip.

Returns:

HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(string, string, string)

HyperlinkInfo

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

public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress, string emailSubject, string screenTip)

Parameters:emailAddressstring

The email address.

emailSubjectstring

The email subject.

screenTipstring

The screen tip.

Returns:

HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(string, string)

HyperlinkInfo

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

public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress, string emailSubject)

Parameters:emailAddressstring

The email address.

emailSubjectstring

The email subject.

Returns:

HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(string)

HyperlinkInfo

Creates an email hyperlink for the specified address.

public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress)

Parameters:emailAddressstring

The email address.

Returns:

HyperlinkInfo

The hyperlink information.

Equals(object)

bool

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters:objobject

The object to compare with the current object.

Returns:

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

GetHashCode()

int

Serves as a hash function for a particular type.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

Properties

Address

string

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

public string Address { get; }

Property Value:

The address.

EmailSubject

string

Gets the email subject line used when Type is Mailto.

public string EmailSubject { get; }

Property Value:

The email subject.

ScreenTip

string

Gets the tooltip text displayed when hovering over the hyperlink.

public string ScreenTip { get; }

Property Value:

The screen tip.

SubAddress

string

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

public string SubAddress { get; }

Property Value:

The sub address.

Type

HyperlinkType

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

public HyperlinkType Type { get; }

Property Value:

The type.