Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

HomePageLayout

Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile. For more information, see “Customizing Home Tab Page Layouts” in the Salesforce online help.

File Suffix and Directory Location

Home page layouts are stored in the homePageLayouts directory of the corresponding package directory. The extension is .homePageLayout.

Version

Home page components are available in API version 12.0 and later. It extends the Metadata metadata type and inherits its fullName field.

Fields

This metadata type represents the valid values that define a home page layout:

Field Name Field Type Description
fullName string The name can only contain characters, letters, and the underscore (_) character, must start with a letter, and cannot end with an underscore or contain two consecutive underscore characters.

Inherited from the Metadata component, this field is not defined in the WSDL for this component. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call.
narrowComponents string[] The list of elements in the narrow column on the left side of the home page.
wideComponents string[] The list of elements in the wide column on the right side of the home page.

Declarative Metadata Sample Definition

The following is the definition of a home page layout. See HomePageComponent and Weblink for related samples.

1<?xml version="1.0" encoding="UTF-8"?>
2<HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">
3    <narrowComponents>google</narrowComponents>
4</HomePageLayout>