Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

RelatedList Class

Represents related list custom components on the sidebars of the Salesforce console.

Namespace

Metadata

Usage

Use this class when accessing Metadata.Layout metadata components. For more information, see “RelatedList” in the Metadata API Developer Guide.

RelatedList Properties

The following are properties for RelatedList.

hideOnDetail

When set to true, the related list is hidden from detail pages where it appears as a component to prevent duplicate information from showing.

Signature

public Boolean hideOnDetail {get; set;}

Property Value

Type: Boolean

name

The name of the component as it appears to console users.

Signature

public String name {get; set;}

Property Value

Type: String

RelatedList Methods

The following are methods for RelatedList.

clone()

Makes a duplicate copy of the Metadata.RelatedList.

Signature

public Object clone()

Return Value

Type: Object