--- schema_version: "1" id: 7c41529dfaa351a9371cf88956618d9bf568248ee1a278b1712593305aada415 title: FieldSet Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_methods_system_fieldsets_describe.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm source_site: developer.salesforce.com content_type: documentation content_hash: 46ad5f2b20c24193d7e1b7ecdff75d395f6d5e47925e10d0c40c05c15cb88c71 description: Contains methods for discovering and retrieving the details of field sets created on sObjects.Returns the field set’s description.Returns a list of Schema.FieldSetMember objects for the fields making up the field set.Returns the translation of the text label that is displayed next to the field in the Salesforce user interface.Returns the field set’s name.Returns the field set’s namespace.Returns the Schema.sObjectType of the sObject containing the field set definition. --- # FieldSet Class Contains methods for discovering and retrieving the details of field sets created on sObjects. ## Namespace [Schema](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Schema.htm "The Schema namespace provides classes and methods for schema metadata information.") ## Usage Use the methods in the Schema.FieldSet class to discover the fields contained within a field set, and get details about the field set itself, such as the name, namespace, label, and so on. The following example shows how to get a collection of field set describe result objects for an sObject. The key of the returned Map is the field set name, and the value is the corresponding field set describe result. Map FsMap = Schema.SObjectType.Account.fieldSets.getMap(); Field sets are also available from sObject describe results. The following lines of code are equivalent to the prior sample: Schema.DescribeSObjectResult d = Account.sObjectType.getDescribe(); Map FsMap = d.fieldSets.getMap(); To work with an individual field set, you can access it via the map of field sets on an sObject or, when you know the name of the field set in advance, using an explicit reference to the field set. The following two lines of code retrieve the same field set: Schema.FieldSet fs1 = Schema.SObjectType.Account.fieldSets.getMap().get('field\_set\_name'); Schema.FieldSet fs2 = Schema.SObjectType.Account.fieldSets.field\_set\_name; ## Example: Displaying a Field Set on a Visualforce Page This sample uses Schema.FieldSet and Schema.FieldSetMember methods to dynamically get all the fields in the Dimensions field set for the Merchandise custom object. The list of fields is then used to construct a SOQL query that ensures those fields are available for display. The Visualforce page uses the MerchandiseDetails class as its controller. public with sharing class MerchandiseDetails { public Merchandise\_\_c merch { get; set; } public MerchandiseDetails() { this.merch = getMerchandise(); } public List getFields() { return SObjectType.Merchandise\_\_c.FieldSets.Dimensions.getFields(); } private Merchandise\_\_c getMerchandise() { String query = 'SELECT '; for(Schema.FieldSetMember f : this.getFields()) { query += f.getFieldPath() + ', '; } query += 'Id, Name FROM Merchandise\_\_c LIMIT 1'; return Database.query(query, AccessLevel.USER\_MODE); } } The Visualforce page using the above controller is simple: One thing to note about the above markup is the expression used to determine if a field on the form should be indicated as being a required field. A field in a field set can be required by either the field set definition, or the field’s own definition. The expression handles both cases. ## FieldSet Methods The following are methods for FieldSet. All are instance methods. - **[getDescription()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getDescription)** Returns the field set’s description. - **[getFields()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getFields)** Returns a list of Schema.FieldSetMember objects for the fields making up the field set. - **[getLabel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getLabel)** Returns the translation of the text label that is displayed next to the field in the Salesforce user interface. - **[getName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getName)** Returns the field set’s name. - **[getNamespace()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getNamespace)** Returns the field set’s namespace. - **[getSObjectType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_fieldsets_describe.htm#apex_Schema_FieldSet_getSObjectType)** Returns the Schema.sObjectType of the sObject containing the field set definition. ### getDescription() Returns the field set’s description. #### Signature public String getDescription() #### Return Value Type: String #### Usage Description is a required field for a field set, intended to describe the context and content of the field set. It’s often intended for administrators who might be configuring a field set defined in a managed package, rather than for end users. ### getFields() Returns a list of Schema.FieldSetMember objects for the fields making up the field set. #### Signature public List getFields() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Schema.FieldSetMember](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Schema_FieldSetMember.htm#apex_class_Schema_FieldSetMember "Contains methods for accessing the metadata for field set member fields.")\> ### getLabel() Returns the translation of the text label that is displayed next to the field in the Salesforce user interface. #### Signature public String getLabel() #### Return Value Type: String ### getName() Returns the field set’s name. #### Signature public String getName() #### Return Value Type: String ### getNamespace() Returns the field set’s namespace. #### Signature public String getNamespace() #### Return Value Type: String #### Usage The returned namespace is an empty string if your organization hasn’t set a namespace, and the field set is defined in your organization. Otherwise, it’s the namespace of your organization, or the namespace of the managed package containing the field set. ### getSObjectType() Returns the Schema.sObjectType of the sObject containing the field set definition. #### Signature public Schema.SObjectType getSObjectType() #### Return Value Type: Schema.SObjectType