Newer Version Available

This content describes an older version of this product. View Latest

Record Layout Item

An item in a record layout.
Property Name Type Description Filter Group and Version Available Version
editableForNew Boolean Indicates whether the item can be edited when creating a new record. Small, 41.0 41.0
editableForUpdate Boolean Indicates whether the item can be edited when updating a record. Small, 41.0 41.0
label String The text label for the item. Small, 41.0 41.0
layoutComponents Collection of components. Collection can contain any of these components: A collection of components that make up the item. Small, 41.0 41.0
lookupIdApiName String The ID field name of a lookup field. Small, 41.0 41.0
required Boolean Indicates whether the field is required in a layout when creating or updating a record. This information is useful to know if you wanted to render required fields with a different treatment, such as a red outline. Small, 41.0 41.0
sortable Boolean Reserved for future use. Small, 41.0 41.0
uiBehavior String Indicates the layout item behavior on the specified layout. The value doesn't reflect user-level or profile-level access. Available values are:
  • Edit—The layout field can be edited but isn’t required.
  • Required—The layout field can be edited and is required.
  • Readonly—The layout field is read-only.

This field applies only to page layouts and mini layouts. For other types of layouts such as compact layouts or quick action layouts, this field is null.

Small, 63.0 63.0