DescribeLayoutResult

Represents a specific layout for the specified sObjectType. Each DescribeLayout is referenced by its unique layout ID and consists of two types of views (represented in this object as arrays of DescribeLayoutSection):

• Detail view—Read-only display of the object. In a detail layout, certain pieces of information (such as address details) might be aggregated into a single DescribeLayoutItem.
• Edit view—Editable display of the object. In an edit layout, individual pieces of information (such as an address) will be broken up into separate fields.

An individual DescribeLayout consists of these fields:

Represents one of two sections of the layout containing either standard or custom buttons.

Represents a single standard button, custom button, or custom link in a DescribeLayout.

Represents the smallest unit in a layout—a field or a separator. To reference a field for display, a client application uses the following notation to reference a field in the describeSObjects() call: LayoutComponent.fieldName.

In API version 31.0 and later, DescribeLayoutComponent is extended with FieldLayoutComponent if both the LayoutComponentType value is Field, and the field being described is either the compound field Address or the compound field Person Name.

Represents an individual feed filter option that you can use to filter the feed.

Represents the layout of the feed view for a feed-based page layout.

Represents an individual item in a DescribeLayoutRow. A DescribeLayoutItem consists of a set of components (DescribeLayoutComponent), each of which is either a field or a separator. For most fields on a layout, there is only one component per layout item. However, in a display-only view, the DescribeLayoutItem might be a composite of the individual fields (for example, an address can consist of street, city, state, country, and postal code data). On the corresponding edit view, each component of the address field would be split up into separate DescribeLayoutItems.

Represents a row in a DescribeLayoutSection. A DescribeLayoutRow consists of one or more DescribeLayoutItem objects. For each DescribeLayoutRow, a DescribeLayoutItem refers either to a specific field or to an “empty” DescribeLayoutItem (a DescribeLayoutItem that contains no DescribeLayoutComponent objects). An empty DescribeLayoutItem can be returned when a given DescribeLayoutRow is sparse (for example, containing more fields on the right column than on the left column). Where there are gaps in the layout, an empty DescribeLayoutItem is returned as a placeholder.

Represents a section of a DescribeLayout and consists of one or more columns and one or more rows (an array of DescribeLayoutRow).

Represents a list of actions assigned to the page layout. Available in API version 28.0 and later.

Represents a QuickAction assigned to the actions list for a page layout. Available in API version 28.0 and later.

When the LayoutComponentType value is CustomLink, this type contains information about a single custom link on the page layout.

Extends the information returned by DescribeLayoutComponent. When the LayoutComponentType value is Field, and the field being described is an Address or Person Name field, FieldLayoutComponent includes information about the field’s components.

Available in API version 31.0 and later.

1DescribeLayoutComponent layoutComponent = layoutComponents[n];
2        // Look for a component representing the BillingAddress field
3        if (layoutComponent.getType() == LayoutComponentType.Field.toString() &&
4        layoutComponent.getValue().equals("BillingAddress") {
5        // Cast this component as a FieldLayoutComponent
6        DescribeLayoutComponent.FieldLayoutComponent addressFieldComponent =
7(FieldLayoutComponent)layoutComponent;
8        // At this point you can access addressFieldComponent
9FieldLayoutComponent-specific methods such as getComponents() or
10getFieldType()
11        }

Represents a single record type picklist in a RecordTypeMapping. The picklistName matches up with the name attribute of each field in the fields array in describeSObjectResult. The picklistValues are the set of acceptable values for the recordType.

Represents a single record type mapping in the recordTypeMappings field in a DescribeLayoutResult object. This object is a map of valid recordTypeIds to layoutId. For displaying a detail view, a client application uses this mapping to determine which layout is associated with the record type on the record. For displaying an edit view, a client application uses this mapping to determine which layout to use (and possibly to allow the user to choose between multiple record types); it will also determine the set of available picklist values.

Represents the Mobile Cards section in a DescribeLayout. Available in API version 29.0 and later.

Represents a single related list in a DescribeLayoutResult.

Represents a single field in a related list returned by DescribeLayoutResult.

Represents the sorting preference for objects in the related list.

1ORDER BY relatedListSort[0].getColumn() DIRECTION, relatedListSort[1].getColumn() DIRECTION

Represents the save options for the layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited.