Control Type

Control interface with base methods and attributes for all controls. This represents the runtime instance of a control. Modifying the properties are immediately reflected in the UI.

Hierarchy

Control
   └─ PageLink
   └─ ContainerControl
   └─ InputControl
   └─ Image

Index

Properties

Methods

Properties

container

container: boolean (optional)

True if the control is a container.

generic

generic: boolean (optional)

getDataSource

getDataSource: function(): any

hidden

hidden: boolean

True if the control is hidden.

Methods

applyDesign

applyDesign(design: Design): void

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

Parameters

Name Type Description
design Design object containing design properties as keys

Returns void

dataContext

dataContext(): any

Returns any

getDesign

getDesign(): Design

Returns the design object of this control.

Returns Design

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.

Returns boolean

metadata

metadata(): ControlMetadata

Returns the metadata object of this control.

Returns ControlMetadata

parent

parent(): Control | Page

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