ContainerControl Type

Container control interface with methods and attributes for all container controls. A container control can contain any number of controls.

Hierarchy

Control
   └─ ContainerControl
      └─ Group
      └─ List
      └─ Part

Index

Properties

Methods

Properties

container

container: boolean

True if the control is a container.

Overrides 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(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.

Inherited from Control.applyDesign

Parameters

Name Type Description
design Design object containing design properties as keys

Returns void

dataContext

dataContext(): any

Inherited from Control.dataContext

Returns any

getControl

getControl(controlName: string): Control

Given the name of a control, returns the control instance.

Parameters

Name Type Description
controlName string control name

Returns Control

getControlById

getControlById(id: string): Control

Given the ID of a control, returns the control instance.

Parameters

Name Type Description
id string control ID

Returns Control

getDesign

getDesign(): Design

Returns the design object of this control.

Inherited from Control.getDesign

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.

Inherited from Control.isEditable

Returns boolean

metadata

metadata(): ContainerControlMetadata

Returns the metadata object of this control.

Overrides Control.metadata

Returns ContainerControlMetadata

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