HyperLink Type

Hyperlink control type. Hyperlink control is a control to represent hyperlinks. Pagelinks can also be used in most cases.

Hierarchy

Value
   └─ HyperLink

Index

Properties

Methods

Events

Properties

container

container: boolean (optional)

True if the control is a container.

Inherited from Control.container

generic

generic: boolean (optional)

Inherited from Control.generic

getDataSource

getDataSource: function(): any

Inherited from Control.getDataSource

hidden

hidden: boolean

True if the control is hidden.

Inherited from Control.hidden

Methods

applyDesign

applyDesign(IDesign: HyperLinkDesign): void

Applies given design to the design on the control. If a design already exists, the prototype chain of the design will be preserved.

Overrides Control.applyDesign

Parameters

Name Type Description
IDesign HyperLinkDesign object containing design properties as keys

Returns void

dataContext

dataContext(): any

Inherited from Control.dataContext

Returns any

getDesign

getDesign(): Design

Returns the design object of this control.

Inherited from Control.getDesign

Returns Design

getHyperLinkValue

getHyperLinkValue(): string

Returns string

getValue

getValue(): string

Returns the value of the control.

Inherited from Value.getValue

Returns string

isEditable

isEditable(): boolean

Boolean indicating if the control is editable. Returns false when either the control or it's parent is not editable. Returns true when both the control and it's parent are editable. Returns true when either the control or it's parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and it's parent's edit-ability is undefined.

Inherited from Control.isEditable

Returns boolean

isHyperLinkURLPresent

isHyperLinkURLPresent(): boolean

Returns boolean

metadata

metadata(): HyperLinkMetadata

Returns the metadata object of this control.

Overrides Value.metadata

parent

parent(): Control | Page

Returns the parent (control or page) of this control.

Inherited from Control.parent

Returns Control | Page

root

root(): Page

Returns the root form instance (page) of this control.

Inherited from Control.root

Returns Page

setBaseURL

setBaseURL(url: string): any

Parameters

Name Type Description
url string

Returns any

setValue

setValue(value: string): void

Sets the value of the control.

Inherited from Value.setValue

Parameters

Name Type Description
value string

Returns void

Events

onDataChanged

onDataChanged: EventHook <null>

An event that is triggered when the input control's data changes.

Inherited from InputControl.onDataChanged