UserInterfaceSettings

Represents the settings that modify the behavior of the org’s user interface. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

A UserInterfaceSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

UserInterfaceSettings components are available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
enableHoverDetails	boolean	Indicates whether an interactive overlay containing record details is displayed (`true`) or not (`false`). The default is `true`. To view hover details for a record, users need the appropriate sharing access and field-level security access for the fields in the mini page layout. Note
enableInlineEdit	boolean	Indicates whether users are allowed to edit field values on a record’s detail page (`true`) or not (`false`). The default is `true`.
enableQuickCreate	boolean	Indicates whether an area displays on a tab home page ( corresponds to the Show Quick Create setting), allowing users to create a record quickly with minimal information (`true`) or not (`false`). The Quick Create area displays by default on the tab home pages for leads, accounts, contacts, and opportunities. You can control whether the Quick Create area is displayed on all relevant tab home pages.

Declarative Metadata Sample Definition

The following is an example of a UserInterfaceSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<UserInterfaceSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3  <enableInlineEdit>true</enableInlineEdit>
4  <enableHoverDetails>false</enableHoverDetails>
5  <enableQuickCreate>true</enableQuickCreate>
6</UserInterfaceSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the user interface settings metadata for an organization:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3	<types>
4		<members>UserInteface</members>
5		<name>Settings</name>
6	</types>
7	<version>46.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide