Interface ControlApiBase<ControlTypeAttributes, ControlFieldType>

This Control API pertains to functionality that checks the state, registers event handlers, and so on.

interface ControlApiBase<ControlTypeAttributes, ControlFieldType> {
    masking: MaskingControlApi;
    state: ControlStateApi;
    type: string;
    getClientFieldProperties(): undefined | FieldTypeToClientFieldProperties<ControlFieldType>;
    getControl(): Control<ControlTypeAttributes>;
    getFieldRestrictions(): FieldTypeToRestrictions<ControlFieldType>;
    getFieldValue(): FieldTypeToValue<ControlFieldType>;
    getFileRestrictions(): FileRestrictions;
    getFormattedDisplayValue(): Promise<undefined | string>;
    isAuthorizedToUnmask(): boolean;
    isMaskedControl(): boolean;
    setFieldValue(value: FieldTypeToValue<ControlFieldType>): void;
}

Type Parameters

ControlTypeAttributes extends TypeAttributes = TypeAttributes
ControlFieldType extends FieldType = never

Hierarchy (view full)

ControlApiBase
- ControlApi

Index

Properties

masking state type

Methods

getClientFieldProperties getControl getFieldRestrictions getFieldValue getFileRestrictions getFormattedDisplayValue isAuthorizedToUnmask isMaskedControl setFieldValue

Properties

masking

masking: MaskingControlApi

Access the Control Data Masking API

`Readonly`state

state: ControlStateApi

Methods related to the state of the control.

`Readonly`type

type: string

Control type.

Methods

getClientFieldProperties

getClientFieldProperties(): undefined | FieldTypeToClientFieldProperties<ControlFieldType>
Returns the client field properties that are associated with the calling control. Field must be configured as dataSource in the control's typeAttributes.

Returns undefined | FieldTypeToClientFieldProperties<ControlFieldType>
The field restrictions that should be applied.

Method

getControl

getControl(): Control<ControlTypeAttributes>
Returns the calling control object.

Returns Control<ControlTypeAttributes>
Object representing the calling control.

Method

getFieldRestrictions

getFieldRestrictions(): FieldTypeToRestrictions<ControlFieldType>
Returns the field restrictions that are associated with the calling control. Field must be configured as dataSource in the control's typeAttributes.

Returns FieldTypeToRestrictions<ControlFieldType>
The field restrictions that should be applied.

Method

getFieldValue

getFieldValue(): FieldTypeToValue<ControlFieldType>
Gives the value of the control's field. Field must be configured as dataSource in the control's typeAttributes.

Returns FieldTypeToValue<ControlFieldType>
The value of the control's field.

Method

getFileRestrictions

getFileRestrictions(): FileRestrictions
Returns the restrictions of the control's file category. File category must be configured as fileCategory in the control's typeAttributes.

Returns FileRestrictions
The file restrictions that should be applied.

Method

getFormattedDisplayValue

getFormattedDisplayValue(): Promise<undefined | string>
Returns the formatted value of the control's field. Field must be configured as dataSource in the control's typeAttributes.

Returns Promise<undefined | string>
A promise that resolves to the formatted field value, or undefined if the field is not found.

Method

isAuthorizedToUnmask

isAuthorizedToUnmask(): boolean
Control Mask Authorization

Returns boolean
Deprecated
use api.control.masking.isAuthorizedToUnmask

isMaskedControl

isMaskedControl(): boolean
Control Mask

Returns boolean
Deprecated
use api.control.masking.isConfiguredForMasking instead.

setFieldValue

setFieldValue(value): void
Sets the value of the control's field. Field must be configured as dataSource in the control's typeAttributes.
Parameters
- value: FieldTypeToValue<ControlFieldType>
  {FieldTypeToValue} New field value.
Returns void
Method