Skip to content

Class: FormCellContainerProxy

FormCellContainerProxy is a developer-facing interface that provides access to a FormCellContainer control. It is passed to rules to provide access to a FormCellContainer control for application-specific customizations.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Currently none in this class.

Inherited Properties

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

Constructor

+ new FormCellContainerProxy(context: IContext): FormCellContainerProxy

Overrides ControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: FormCellContainerProxy

Methods

getCaption

getCaption(): string

This method always returns an empty string. Note: FormCellContainer does not support container-level caption. Individual sections within the container have their own caption properties.

Implementation of IResetableContainerProxy.getCaption Overrides ControlProxy.getCaption

Returns: string

Always returns an empty string.


getControl

getControl(name: string): IControlProxy

Returns a control proxy for the control with the specified name within the FormCellContainer.

Implementation of IResetableContainerProxy.getControl

Parameters:

Name Type Description
name string The name of the control to retrieve.

Returns: IControlProxy

The control proxy, or undefined if not found.


getControls

getControls(): IControlProxy[]

Gets all the child controls for this container.

Implementation of IResetableContainerProxy.getControls

Returns: IControlProxy[]

array of FormCellControlProxy instances


isContainer

isContainer(): boolean

Determines if this control is a FormCellContainer. By default FormCellContainer is a container.

Overrides ControlProxy.isContainer

Returns: boolean

true/false. It always returns true for FormCellContainer.


reset

reset(): Promise<any>

Resets all controls in the FormCellContainer.

Implementation of IResetableContainerProxy.reset

Returns: Promise<any>

A promise that resolves when the reset is complete.