Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallbackContext Class
DeployContainer Class
DeployDetails Class
DeployMessage Class
DeployProblemType Enum
DeployResult Class
DeployStatus Enum
FeedItemTypeEnum Enum
FeedLayout Class
FeedLayoutComponent Class
FeedLayoutComponentType Enum
FeedLayoutFilter Class
FeedLayoutFilterPosition Enum
FeedLayoutFilterType Enum
Layout Class
Layout Properties
Layout Methods
LayoutColumn Class
LayoutHeader Enum
LayoutItem Class
LayoutSection Class
LayoutSectionStyle Enum
Metadata Class
MetadataType Enum
MetadataValue Class
MiniLayout Class
Operations Class
PlatformActionList Class
PlatformActionListContextEnum Enum
PlatformActionListItem Class
PlatformActionTypeEnum Enum
PrimaryTabComponents Class
QuickActionList Class
QuickActionListItem Class
RelatedContent Class
RelatedContentItem Class
RelatedList Class
RelatedListItem Class
ReportChartComponentLayoutItem Class
ReportChartComponentSize Enum
SidebarComponent Class
SortOrder Enum
StatusCode Enum
SubtabComponents Class
SummaryLayoutStyleEnum Enum
SummaryLayout Class
SummaryLayoutItem Class
UiBehavior Enum
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

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

Layout Class

Represents the metadata associated with a page layout.

Namespace

Metadata

Usage

Use this class to access layout metadata components. For more information, see Layout in the Metadata API Developer Guide.

Layout Properties

The following are properties for Layout.

customButtons

The custom buttons for this layout.

Signature

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

Property Value

Type: List<String>

customConsoleComponents

Represents custom console components (Visualforce pages, lookup fields, or related lists) on a page layout.

Signature

public Metadata.CustomConsoleComponents customConsoleComponents {get; set;}

Property Value

Type: CustomConsoleComponents Class

emailDefault

Default value for the email checkbox. Only relevant if the showEmailCheckbox property is set.

Signature

public Boolean emailDefault {get; set;}

Property Value

Type: Boolean

excludeButtons

List of standard buttons to exclude from this layout.

Signature

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

Property Value

Type: List<String>

feedLayout

Represents the values that define the feed view of a feed-based page layout.

Signature

public Metadata.FeedLayout feedLayout {get; set;}

Property Value

Type: Metadata.FeedLayout

headers

Represents the layout headers used for tagging.

Signature

public List<Metadata.LayoutHeader> headers {get; set;}

Property Value

Type: List<Metadata.LayoutHeader>

layoutSections

The main sections of the layout containing fields, s-controls, and custom links. The order here determines the layout order.

Signature

public List<Metadata.LayoutSection> layoutSections {get; set;}

Property Value

Type: List<Metadata.LayoutSection>

miniLayout

Represents a minilayout, which is used in the mini view of a record in the Console tab, hover details, and event overlays.

Signature

public Metadata.MiniLayout miniLayout {get; set;}

Property Value

Type: Metadata.MiniLayout

multilineLayoutFields

Fields for special multiline layout fields which appear in OpportunityProduct layouts.

Signature

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

Property Value

Type: List<String>

platformActionList

The list of actions, and their order, that display in the Salesforce mobile action bar for the layout.

Signature

public Metadata.PlatformActionList platformActionList {get; set;}

Property Value

Type: Metadata.PlatformActionList

quickActionList

The list of quick actions that display in the full Salesforce site for the page layout.

Signature

public Metadata.QuickActionList quickActionList {get; set;}

Property Value

Type: Meatadata.QuickActionL.

relatedContent

The Related Content section of the page layout.

Signature

public Metadata.RelatedContent relatedContent {get; set;}

Property Value

Type: Metadata.RelatedContent

relatedLists

The related lists for the layout, listed in the order they appear in the user interface.

Signature

public List<Metadata.RelatedListItem> relatedLists {get; set;}

Property Value

Type: List<Metadata.RelatedListItem>

relatedObjects

The list of related objects that appears in the mini view of the console.

Signature

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

Property Value

Type: List<String>

runAssignmentRulesDefault

Default value for the “run assignment rules” checkbox. Only relevant if the showRunAssignmentRulesCheckbox property is set.

Signature

public Boolean runAssignmentRulesDefault {get; set;}

Property Value

Type: Boolean

showEmailCheckbox

Controls whether to show the email checkbox. Only allowed on Case, CaseClose, and Task layouts. The default state of checkbox is controlled by the emailDefault property.

Signature

public Boolean showEmailCheckbox {get; set;}

Property Value

Type: Boolean

showHighlightsPanel

If set, the highlights panel displays on pages in the Salesforce console.

Signature

public Boolean showHighlightsPanel {get; set;}

Property Value

Type: Boolean

showInteractionLogPanel

If set, the interaction log displays on pages in the Salesforce console.

Signature

public Boolean showInteractionLogPanel {get; set;}

Property Value

Type: Boolean

showKnowledgeComponent

Only allowed on Case layouts. If set, the Knowledge sidebar displays on cases in the Salesforce console.

Signature

public Boolean showKnowledgeComponent {get; set;}

Property Value

Type: Boolean

showRunAssignmentRulesCheckbox

Controls whether to show the Run Assignment Rules checkbox. Only allowed on Lead and Case layouts. The default state of checkbox is controlled by the runAssignmentRulesDefault property.

Signature

public Boolean showRunAssignmentRulesCheckbox {get; set;}

Property Value

Type: Boolean

showSolutionSection

Only allowed on CaseClose layout. If set, the built-in solution information section shows up on the page.

Signature

public Boolean showSolutionSection {get; set;}

Property Value

Type: Boolean

showSubmitAndAttachButton

For Cast layouts only. If set, the Submit & Add Attachment button displays on case edit pages to portal users in the Customer Portal.

Signature

public Boolean showSubmitAndAttachButton {get; set;}

Property Value

Type: Boolean

summaryLayout

The summary layout for this layout.

Signature

public Metadata.SummaryLayout summaryLayout {get; set;}

Property Value

Type: Metadata.SummaryLayout

Layout Methods

The following are methods for Layout.

clone()

Makes a duplicate copy of the Metadata.Layout.

Signature

public Object clone()

Return Value

Type: Object