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

HomePageComponent

Represents the metadata associated with a home page component. You can customize the Home tab to include components such as sidebar links, a company logo, or a dashboard snapshot. For more information, see “Customizing Home Tab Page Layouts” in the Salesforce online help. It extends the Metadata metadata type and inherits its fullName field. Use to create, update, or delete home page component definitions.

Declarative Metadata File Suffix and Directory Location

The file suffix for home page components is .homePageComponent and components are stored in the homepagecomponents directory of the corresponding package directory.

Version

Home page components are available in API version 12.0 and later.

HomePageComponent

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

Field Name Field Type Description
body string If this is an HTML page component, this is the body of the HTML.
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.
links string[] If the pageComponentType is links, then zero or more names of custom page links can be specified.
  • ObjectWebLink
  • CustomPageWebLink
pageComponentType PageComponentType (enumeration of type string) Required. Valid values are the following:
  • links
  • htmlArea
  • imageOrNote
width PageComponentWidth (enumeration of type string) This field is only available for HTML components, and indicates whether this is a narrow or wide home page component. Valid values are the following:
  • narrowComponents
  • wideComponents

Declarative Metadata Sample Definition

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

1<?xml version="1.0" encoding="UTF-8"?>
2<HomePageComponent xmlns="http://soap.sforce.com/2006/04/metadata">
3    <width>wideComponents</width>
4    <links>google</links>
5    <pageComponentType>links</pageComponentType>
6</HomePageComponent>