Hyperlink Class |  |
Represents a hyperlink to a URL, a sheet, or a report.
Remarks
RemarksIf 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.
Inheritance HierarchyNamespace: Smartsheet.Api.Models
Assemblies: smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
SyntaxThe Hyperlink type exposes the following members.
Constructors
Properties| Name | Description | |
|---|---|---|
 | IsNull |
Get the value of the isNull flag
|
| ReportId |
If non-null, this hyperlink is a link to the report with this Id.
|
| SheetId |
If non-null, this hyperlink is a link to the sheet with this Id.
|
| SightId |
If non-null, this hyperlink is a link to the Sight with this Id.
|
| 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. |
See Also