Lookup Type

Lookup control type. A lookup is an input control that is used to select an input from a list of options. For example, a lookup could be used to lookup a customer when linking a customer to a new sales order.

Hierarchy

InputControl
   └─ Lookup

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: LookupDesign): 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 LookupDesign 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

getDisplayValue

getDisplayValue(): string

Returns string

getLookupPage

getLookupPage(): Page

Returns Page

getValue

getValue(): string | number

Returns string | number

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

metadata

metadata(): LookupMetadata

Returns the metadata object of this control.

Overrides InputControl.metadata

Returns LookupMetadata

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

setEntityRef

setEntityRef(newValue: string | number): Promise <any>

Parameters

Name Type Description
newValue string | number

Returns Promise <any>

Events

onDataChanged

onDataChanged: EventHook <null>

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

Inherited from InputControl.onDataChanged