ControlsFactory Class

A base factory that enables you to register custom controls.

Declaration

class ControlsFactory

Inheritance

ControlsFactory

ControlsFactory

Methods

getControlInfo(controlType) Method

Returns information about the specified control.

Declaration

getControlInfo(
    controlType: string
): Elements.IElementMetadata

Parameters

Name	Type	Description
controlType	string	The control type.

Returns

Type	Description
IElementMetadata	An object that provides information about a control.

getControlType(model) Method

Returns a control type by the specified model.

Declaration

getControlType(
    model: any
): string

Parameters

Name	Type	Description
model	any	The control model.

Returns

Type	Description
string	The control type.

getPropertyInfo(controlType, path) Method

Returns information about the specified property of the specified control.

Declaration

getPropertyInfo(
    controlType: string,
    path: any
): any

Parameters

Name	Type	Description
controlType	string	The control type.
path	any	The property display name.

Returns

Type	Description
any	An object that provides property information.

registerControl(typeName, metadata) Method

Registers the specified control.

Declaration

registerControl(
    typeName: string,
    metadata: Elements.IElementMetadata
): void

Parameters

Name	Type	Description
typeName	string	The name of a custom control.
metadata	IElementMetadata	An object that provides information about a control.