Class Hyperlink

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

Represents a hyperlink to a URL, a sheet, or a report. If the sheet or report that is linked to was deleted, this object may be empty (i.e., all values null).

You can create and modify hyperlinks by using any API operation that creates or updates cell data. When creating or updating a hyperlink, cell.value may be set to a string value or null. If null, the cell’s value will be derived from the hyperlink:

• If the hyperlink is a URL link, the cell’s value will be set to the URL itself.
• If the hyperlink is a sheet or report link, the cell’s value will be set to the sheet or report’s name.

public class Hyperlink

Inheritance

object

Hyperlink

Derived

WidgetHyperlink

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsNull

Get the value of the isNull flag

[JsonIgnore]
public bool IsNull { get; }

Property Value

bool

value of the isNull flag

ReportId

If non-null, this hyperlink is a link to the report with this Id.

public long? ReportId { get; set; }

Property Value

long?

SheetId

If non-null, this hyperlink is a link to the sheet with this Id.

public long? SheetId { get; set; }

Property Value

long?

the sheet Id

SightId

If non-null, this hyperlink is a link to the Sight with this Id.

public long? SightId { get; set; }

Property Value

long?

Url

When the hyperlink is a URL link, this property will contain the URL value.

When the hyperlink is a sheet/report link (i.e., sheetId or reportId is non-null), this property will contain the permalink to the sheet or report.

public string Url { get; set; }

Property Value

string

the Url