HyperLink type
Important
The finance and operations (Dynamics 365) mobile app and platform are no longer supported. The platform components supporting the mobile app will be removed in a future update. The mobile app has also been removed from app stores. Previously installed instances of the app will continue to work. For more information, see Removed or deprecated platform features.
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
- applyDesign
- dataContext
- getDesign
- getHyperLinkValue
- getValue
- isEditable
- isHyperLinkURLPresent
- metadata
- parent
- root
- setBaseURL
- setValue
Events
Properties
container
container: boolean (optional)
True if the control is a container.
generic
generic: boolean (optional)
getDataSource
getDataSource: function(): any
Inherited from Control.getDataSource
hidden
hidden: boolean
True if the control is 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.
Returns Design
getHyperLinkValue
getHyperLinkValue(): string
Returns string
getValue
getValue(): string
Returns the value of the control.
Returns string
isEditable
isEditable(): boolean
Boolean indicating if the control is editable. Returns false when either the control or its parent is not editable. Returns true when both the control and its parent are editable. Returns true when either the control or its parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and its 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.
Returns HyperLinkMetadata
parent
Returns the parent (control or page) of this control.
Returns Control | Page
root
root(): Page
Returns the root form instance (page) of this control.
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.
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