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
LoadFormData Class
LoadParameters Class
PreferenceCenterApexHandler Interface
SubmitFormData Class
SubmitFormData Methods
SubmitParameters Class
TokenType Enum
TokenUtility Class
ValidationResult Class
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
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.

SubmitFormData Class

Contains methods to retrieve information on buttons and options selected in a preference form.

Namespace

Pref_center

Example

Use methods in the SubmitFormData class to retrieve the selected values in different form components:

1String buttonClickedId = formData.getButtonClicked();
2if (buttonClickedId == 'submitButton') {
3// Handle form submit
4} else if (buttonClickedId == 'cancelButton') {
5// Handle form cancel
6}
7
8String picklistValueOld = formData.getOldSelectedValue('myPicklist');
9String picklistValueNew = formData.getSelectedValue('myPicklist');
10if (picklistValueOld != picklistValueNew) {
11// Do something
12}
13
14List<String> checkboxValuesOld = formData.getOldSelectedValues('myCheckbox');
15List<String> checkboxValuesNew = formData.getSelectedValues('myCheckbox');
16if (checkboxValuesOld != null && checkboxValuesNew != null && (checkboxValuesOld.size() != checkboxValuesNew.size())) {
17// Do something
18}
19
20String textinputValueOld = formData.getOldStringValue('myTextinput');
21String textinputValueNew = formData.getStringValue('myTextinput');
22if (textinputValueOld != textinputValueNew) {
23// Do something
24}

SubmitFormData Methods

The following are methods for SubmitFormData.

getButtonClicked()

Returns the field ID of the button that was clicked in the preference form. For example, use this method to determine if the clicked button was Submit or Cancel.

Signature

public String getButtonClicked()

Return Value

Type: String

getOldSelectedValue(fieldId)

Returns the value that was set for the specified field when the preference form was previously edited by the user. This method is used for field types such as picklist or radio buttons.

Signature

public String getOldSelectedValue(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: String

getOldSelectedValues(fieldId)

Returns a list of the string values that were set on a checkbox field when the preference form was previously edited by the user.

Signature

public List<String> getOldSelectedValues(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: List<String>

getOldStringValue(fieldId)

Returns the string value that was set on a field when the preference form was loaded. This method is used for field types such as text, and throws a TypeException if used with a field that can return more than one value, like a checkbox field.

Signature

public String getOldStringValue(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: String

getSelectedValue(fieldId)

Returns the string value that is currently selected for a picklist or radio button field in the preference form.

Signature

public String getSelectedValue(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: String

getSelectedValues(fieldId)

Returns a list of string values that are currently selected on a checkbox field in the preference form.

Signature

public List<String> getSelectedValues(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: List<String>

getStringValue(fieldId)

Returns the string value that was set on a field when the preference form was loaded. This method is used for field types such as text.

Signature

public String getStringValue(String fieldId)

Parameters

  • fieldId: Type: String Identifies a field in the preference form.

Return Value

Type: String