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.

RelatedListItem Class

Represents an item in the related list in a page layout.

Namespace

Metadata

Usage

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

RelatedListItem Properties

The following are properties for RelatedListItem.

customButtons

A list of custom buttons used in the related list.

Signature

public List<String> customButtons {get; set;}

Property Value

Type: List<String>

For more information, see “Define Custom Buttons and Links” in the Salesforce online help.

excludeButtons

A list of excluded related-list buttons.

Signature

public List<String> excludeButtons {get; set;}

Property Value

Type: List<String>

fields

A list of fields displayed in the related list. Uses aliases instead of field or API names.

Signature

public List<String> fields {get; set;}

Property Value

Type: List<String>

quickActions

A list of quick actions used on the related list.

Signature

public List<String> quickActions {get; set;}

Property Value

Type: List<String>

relatedList

The name of the related list.

Signature

public String relatedList {get; set;}

Property Value

Type: String

sortField

The name of the field used for sorting.

Signature

public String sortField {get; set;}

Property Value

Type: String

sortOrder

When sortField is set, the sortOrder property determines the sort order.

Signature

public Metadata.SortOrder sortOrder {get; set;}

Property Value

Type: Metadata.SortOrder

RelatedListItem Methods

The following are methods for RelatedListItem.

clone()

Makes a duplicate copy of the Metadata.RelatedListItem.

Signature

public Object clone()

Return Value

Type: Object