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.

CustomApplicationComponent

Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console. Custom console components extend the capabilities of Salesforce console apps. See Customize a Console with Custom Components in Salesforce Classic in Salesforce Help.

File Suffix and Directory Location

Custom application components have the suffix .customApplicationComponent and are stored in the customApplicationComponents folder.

Version

Custom applications are available in API version 25.0 and later.

Fields

Field Name	Field Type	Description
buttonIconUrl	string	The address of a page that hosts an icon for the button.
buttonStyle	string	The inline style used to define how the button looks.
buttonText	string	The label on the button used to launch the custom console component.
buttonWidth	int	The pixel width of the button displayed in the Salesforce console.
height	int	The pixel height of the window used to display the custom console component.
isHeightFixed	boolean	Required. Indicates whether users can change the custom console component height (`false`) or not (`true`).
isHidden	boolean	Required. Indicates whether the custom console component is hidden from users (`true`) or not (`false`).
isWidthFixed	boolean	Required. Indicates whether users can change the component width (`false`) or not (`true`).
visualforcePage	string	Required. Name of the Visualforce page that represents the custom console component.
width	int	The pixel width of the window used to display the custom console component.

Declarative Metadata Sample Definition

The following is the definition of a custom application component:

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomApplicationComponent xmlns="http://soap.sforce.com/2006/04/metadata">
3    <buttonIconUrl>https://salesforce.com</buttonIconUrl>
4    <buttonStyle>buttonStyleCSS</buttonStyle>
5    <buttonText>buttonText</buttonText>
6    <buttonWidth>200</buttonWidth>
7    <height>200</height>
8    <isHeightFixed>false</isHeightFixed>
9    <isHidden>false</isHidden>
10    <isWidthFixed>false</isWidthFixed>
11    <visualforcePage>MyVisualforcePage</visualforcePage>
12    <width>50</width>
13</CustomApplicationComponent>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide