Class
HyperlinkInfo

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:

cs-api-definition

public class HyperlinkInfo

Inheritance: objectHyperlinkInfo

Properties

Address

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

Declaration

cs-api-definition

public string Address { get; }

Property Value

string

The address.

EmailSubject

Gets the email subject line used when Type is Mailto.

Declaration

cs-api-definition

public string EmailSubject { get; }

Property Value

string

The email subject.

ScreenTip

Gets the tooltip text displayed when hovering over the hyperlink.

Declaration

cs-api-definition

public string ScreenTip { get; }

Property Value

string

The screen tip.

SubAddress

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

Declaration

cs-api-definition

public string SubAddress { get; }

Property Value

string

The sub address.

Type

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

Declaration

cs-api-definition

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

cs-api-definition

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

Parameters

address

string

The address.

screenTip

string

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

cs-api-definition

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

Parameters

subAddress

string

The sub address.

screenTip

string

The screen tip.

Returns

HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(string)

Creates an email hyperlink for the specified address.

Declaration

cs-api-definition

public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress)

Parameters

emailAddress

string

The email address.

Returns

HyperlinkInfo

The hyperlink information.

CreateMailtoHyperlink(string, string)

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

Declaration

cs-api-definition

public static HyperlinkInfo CreateMailtoHyperlink(string emailAddress, string emailSubject)

Parameters

emailAddress

string

The email address.

emailSubject

string

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

cs-api-definition

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

Parameters

emailAddress

string

The email address.

emailSubject

string

The email subject.

screenTip

string

The screen tip.

Returns

HyperlinkInfo

The hyperlink information.

Equals(object)

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

Declaration

cs-api-definition

public override bool Equals(object obj)

Parameters

obj

object

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()

Serves as a hash function for a particular type.

Declaration

cs-api-definition

public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

ClassHyperlinkInfo

Class
HyperlinkInfo