Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
ChildRelationship Class
DataCategory Class
DataCategoryGroupSobjectTypePair Class
DescribeColorResult Class
Describe​DataCategoryGroupResult Class
Describe​DataCategoryGroupStructureResult Class
DescribeFieldResult Class
DescribeIconResult Class
DescribeSObjectResult Class
DescribeTabResult Class
DescribeTabSetResult Class
DisplayType Enum
FieldDescribeOptions Enum
FieldSet Class
FieldSetMember Class
FieldSetMember Methods
PicklistEntry Class
RecordTypeInfo Class
SOAPType Enum
SObjectDescribeOptions Enum
SObjectField Class
SObjectType Class
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

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.

FieldSetMember Class

Contains methods for accessing the metadata for field set member fields.

Namespace

Schema

Usage

Use the methods in the Schema.FieldSetMember class to get details about fields contained within a field set, such as the field label, type, a dynamic SOQL-ready field path, and so on. The following example shows how to get a collection of field set member describe result objects for a specific field set on an sObject:
1List<Schema.FieldSetMember> fields = 
2    Schema.SObjectType.Account.fieldSets.getMap().get('field_set_name').getFields();
If you know the name of the field set in advance, you can access its fields more directly using an explicit reference to the field set:
1List<Schema.FieldSetMember> fields = 
2    Schema.SObjectType.Account.fieldSets.field_set_name.getFields();

FieldSetMember Methods

The following are methods for FieldSetMember. All are instance methods.

getDBRequired()

Returns true if the field is required by the field’s definition in its sObject, otherwise, false.

Signature

public Boolean getDBRequired()

Return Value

Type: Boolean

getFieldPath()

Returns a field path string in a format ready to be used in a dynamic SOQL query.

Signature

public String getFieldPath()

Return Value

Type: String

Example

See Displaying a Field Set on a Visualforce Page for an example of how to use this method.

getLabel()

Returns the text label that’s displayed next to the field in the Salesforce user interface.

Signature

public String getLabel()

Return Value

Type: String

getRequired()

Returns true if the field is required by the field set, otherwise, false.

Signature

public Boolean getRequired()

Return Value

Type: Boolean

getType()

Returns the field’s Apex data type.

Signature

public Schema.DisplayType getType()

Return Value

Type: Schema.DisplayType

getSObjectField()

Returns the token for this field.

Signature

public Schema.sObjectField getSObjectField()

Return Value

Type: Schema.SObjectField