Skip to content

Class ExcelHyperLink

Namespace: OfficeOpenXml
Assembly: EPPlus.dll

HyperlinkClass

public class ExcelHyperLink : Uri, ISpanFormattable, IFormattable, IEquatable<Uri>, ISerializable

Inheritance

object ← Uri ← ExcelHyperLink

Implements

IEquatable<Uri>
IFormattable
ISerializable
ISpanFormattable

Inherited Members

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()
Uri.AbsolutePath
Uri.AbsoluteUri
Uri.Authority
Uri.Canonicalize()
Uri.CheckHostName\(string?\)
Uri.CheckSchemeName\(string?\)
Uri.CheckSecurity()
Uri.Compare\(Uri?, Uri?, UriComponents, UriFormat, StringComparison\)
Uri.DnsSafeHost
Uri.Equals\(object?\)
Uri.Equals\(Uri?\)
Uri.Escape()
Uri.EscapeDataString\(ReadOnlySpan<char\>\)
Uri.EscapeDataString\(string\)
Uri.EscapeString\(string?\)
Uri.EscapeUriString\(string\)
Uri.Fragment
Uri.FromHex\(char\)
Uri.GetComponents\(UriComponents, UriFormat\)
Uri.GetHashCode()
Uri.GetLeftPart\(UriPartial\)
Uri.GetObjectData\(SerializationInfo, StreamingContext\)
Uri.HexEscape\(char\)
Uri.HexUnescape\(string, ref int\)
Uri.Host
Uri.HostNameType
Uri.IdnHost
Uri.IsAbsoluteUri
Uri.IsBadFileSystemCharacter\(char\)
Uri.IsBaseOf\(Uri\)
Uri.IsDefaultPort
Uri.IsExcludedCharacter\(char\)
Uri.IsFile
Uri.IsHexDigit\(char\)
Uri.IsHexEncoding\(string, int\)
Uri.IsLoopback
Uri.IsReservedCharacter\(char\)
Uri.IsUnc
Uri.IsWellFormedOriginalString()
Uri.IsWellFormedUriString\(string?, UriKind\)
Uri.LocalPath
Uri.MakeRelative\(Uri\)
Uri.MakeRelativeUri\(Uri\)
Uri.OriginalString
Uri.Parse()
Uri.PathAndQuery
Uri.Port
Uri.Query
Uri.Scheme
Uri.SchemeDelimiter
Uri.Segments
Uri.ToString()
Uri.TryCreate\(string?, in UriCreationOptions, out Uri?\)
Uri.TryCreate\(string?, UriKind, out Uri?\)
Uri.TryCreate\(Uri?, string?, out Uri?\)
Uri.TryCreate\(Uri?, Uri?, out Uri?\)
Uri.TryEscapeDataString\(ReadOnlySpan<char\>, Span<char\>, out int\)
Uri.TryFormat\(Span<char\>, out int\)
Uri.TryUnescapeDataString\(ReadOnlySpan<char\>, Span<char\>, out int\)
Uri.Unescape\(string\)
Uri.UnescapeDataString\(ReadOnlySpan<char\>\)
Uri.UnescapeDataString\(string\)
Uri.UriSchemeFile
Uri.UriSchemeFtp
Uri.UriSchemeFtps
Uri.UriSchemeGopher
Uri.UriSchemeHttp
Uri.UriSchemeHttps
Uri.UriSchemeMailto
Uri.UriSchemeNetPipe
Uri.UriSchemeNetTcp
Uri.UriSchemeNews
Uri.UriSchemeNntp
Uri.UriSchemeSftp
Uri.UriSchemeSsh
Uri.UriSchemeTelnet
Uri.UriSchemeWs
Uri.UriSchemeWss
Uri.UserEscaped
Uri.UserInfo

Constructors

ExcelHyperLink(string)

A new hyperlink with the specified URI

public ExcelHyperLink(string uriString)

Parameters

uriString string

The URI

ExcelHyperLink(string, UriKind)

A new hyperlink with the specified URI and kind

public ExcelHyperLink(string uriString, UriKind uriKind)

Parameters

uriString string

The URI

uriKind UriKind

Kind (absolute/relative or indeterminate)

ExcelHyperLink(string, string)

Sheet internal reference.

public ExcelHyperLink(string referenceAddress, string display)

Parameters

referenceAddress string

The address or defined name

display string

Displayed text

Properties

ColSpan

If the hyperlink spans multiple columns

public int ColSpan { get; set; }

Property Value

int

Display

Displayed text

public string Display { get; set; }

Property Value

string

OriginalUri

Used to handle non absolute URI's. Is used if IsAblsoluteUri is true. The base URI will have a dummy value of xl://nonAbsolute.

public Uri OriginalUri { get; }

Property Value

Uri

ReferenceAddress

The Excel address for internal links or extended data for external hyper links not supported by the Uri class.

public string ReferenceAddress { get; set; }

Property Value

string

RowSpan

If the hyperlink spans multiple rows

public int RowSpan { get; set; }

Property Value

int

ToolTip

Tooltip

public string ToolTip { get; set; }

Property Value

string