In This Topic ▼

value Property

Summary

Value if this is an external link.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentLink.prototype, 'value', 
   get: function(), 
   set: function(value) 
)

value: string;

Property Value

The value of the external link. Default value is null.

Remarks

Typically, a URL to an external resource (hyperlink) is stored here. This value is user-defined and can be anything, it is up to the implementation of the document and the viewing application to determine the format and valid ranges for Value.

Value should be used when LinkType is DocumentLinkType.Value.

Viewer applications can use this value to provide UI support for links. Typically, change the pointer when it hovers over the link Bounds and perform the action when the user clicks on this area: either go to Target if this is an internal link or invoke the hyperlink in Value if this is an external link depending on LinkType.

Requirements

Target Platforms