FieldSet

Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's first name, middle name, last name, and business title. Field sets can be referenced on Visualforce pages dynamically. If the page is added to a managed package, administrators can add, remove, or reorder fields in a field set to modify the fields presented on the Visualforce page without modifying any code.

Version

FieldSet components are available in API version 21.0 and later.

Fields

Field	Field Type	Description
availableFields	FieldSetItem[]	An array containing all the possible fields in the field set.
description	string	Required. A description provided by the developer that describes the field set. This is required.
displayedFields	FieldSetItem[]	An array containing all the fields that are presented on the Visualforce page. The order in which a field is listed determines the order of appearance on the page.
label	string	Required. The label used to reference the field set.

FieldSetItem

FieldSetItem represents an individual field in a field set.

Field	Field Type	Description
field	string	Required. The name of a field in a standard or custom object.
isFieldManaged	boolean	Read-only. Denotes whether the field was added to the field set via a managed or unmanaged package.
isRequired	boolean	Read-only. Indicates whether the field is universally required (`true`) or not (`false`).

Declarative Metadata Sample Definition

A sample XML definition of a FieldSet component is shown below.

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fieldSets>
4        <fullName>FieldSetNames</fullName>
5        <availableFields>
6            <field>MiddleName__c</field>
7        </availableFields>
8        <availableFields>
9            <field>Title__c</field>
10        </availableFields>
11        <description>FieldSet containing how to properly address someone</description>
12        <displayedFields>
13            <field>FirstName__c</field>
14        </displayedFields>
15        <displayedFields>
16            <field>LastName__c</field>
17        </displayedFields>
18        <label>FieldSet Names</label>
19    </fieldSets>
20</CustomObject>

Metadata API Developer Guide

FieldSet

Version

Fields

FieldSetItem

Declarative Metadata Sample Definition