Interface ControlPageFieldApi

API methods related to object fields associated with a page.

interface ControlPageFieldApi {
    getClientFieldProperties<Type>(field: string): undefined | FieldTypeToClientFieldProperties<Type>;
    getFieldRestrictions<Type>(field: string): FieldTypeToRestrictions<Type>;
    getFieldValue<Type>(field: string): FieldTypeToValue<Type>;
    getFormattedDisplayValue(field: string): Promise<undefined | string>;
    setFieldValue<Type>(value: FieldTypeToValue<Type>, field: string): void;
}

Index

Methods

getClientFieldProperties getFieldRestrictions getFieldValue getFormattedDisplayValue setFieldValue

Methods

getClientFieldProperties

getClientFieldProperties<Type>(field): undefined | FieldTypeToClientFieldProperties<Type>
Returns the client field properties that are associated with the calling control.
Type Parameters
- Type extends FieldType
Parameters
- field: string
  {string} Field name to get client field properties for.
Returns undefined | FieldTypeToClientFieldProperties<Type>
Configured client field properties.

Method

getFieldRestrictions

getFieldRestrictions<Type>(field): FieldTypeToRestrictions<Type>
Returns the field restrictions that are associated with the calling control.
Type Parameters
- Type extends FieldType
Parameters
- field: string
  {string} Field name to get restrictions for.
Returns FieldTypeToRestrictions<Type>
Applied field restrictions.

Method

getFieldValue

getFieldValue<Type>(field): FieldTypeToValue<Type>
Returns the value of the supplied field. This works only with fields for the current object with which the control is associated. For example, if the control is on a parent object, you cannot get a child's field.
Type Parameters
- Type extends FieldType
Parameters
- field: string
  {string} Field name.
Returns FieldTypeToValue<Type>
Method

getFormattedDisplayValue

getFormattedDisplayValue(field): Promise<undefined | string>
Returns the formatted value of the supplied field. This works only with fields for the current object with which the control is associated.
Parameters
- field: string
  {string} Field name.
Returns Promise<undefined | string>
A promise that resolves to the formatted field value, or undefined if the field is not found.

Method

setFieldValue

setFieldValue<Type>(value, field): void
Sets the value of the supplied field. This works only with fields for the current object with which the control is associated. For example, if the control is on a parent object, you cannot set a child's field.
Type Parameters
- Type extends FieldType
Parameters
- value: FieldTypeToValue<Type>
  {FieldTypeToValue} New field value.
- field: string
  {string} Field name.
Returns void
Method