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
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace (Developer Preview)
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Beta)
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
LoadFormData Class
LoadFormData Constructors
LoadFormData Methods
LoadParameters Class
PreferenceCenterApexHandler Interface
SubmitFormData Class
SubmitParameters Class
TokenType Enum
TokenUtility Class
ValidationResult Class
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

LoadFormData Class

Retrieve records related to the tokenized record id, and populate the values of a preference form.

Namespace

Pref_center

Example

Use methods in the LoadFormData class to set available and selected values in different form components:

LoadFormData Constructors

The following are constructors for LoadFormData.

LoadFormData(data)

Creates an instance of the LoadFormData class for running tests on any custom Apex classes you create for Preference Manager.

Signature

public LoadFormData(Map<String,pref_center.FieldProperties> data)

Parameters

data
Type: Map<String,pref_center.FieldProperties>Map
Maps preference form data from the field ID to the field properties.

Usage

This constructor is available in API version 56.0 and later.

LoadFormData Methods

The following are methods for LoadFormData.

addOption(fieldId, value, label)

Add an option for a checkbox, picklist, or radio button field in a preference form using the label and value.

Signature

public void addOption(String fieldId, String value, String label)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
value
Type: String
Represents the selection or text entered in a preference form field.
label
Type: String
The label for the value of a field in a preference form.

Return Value

Type: void

addOption(fieldId, option)

Add a defined, selectable option for a checkbox, picklist, or radio button field in a preference form.

Signature

public void addOption(String fieldId, System.SelectOption option)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
option
Type: System.SelectOption
The option selected on a field in the preference form.

Return Value

Type: void

addSelectedOption(fieldId, option)

Add a selected option for a checkbox field in a preference form. This requires the field on the form to have a defined option with a set value.

Signature

public void addSelectedOption(String fieldId, String option)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
option
Type: String
The selectable option being added.

Return Value

Type: void

setButtonLabel(fieldId, label)

Set the label of a button added to the preference form.

Signature

public void setButtonLabel(String fieldId, String label)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
label
Type: String
The label for a button added to the preference form.

Return Value

Type: void

setOptions(fieldId, options)

Add a list of selectable options for a field on a preference form.

Signature

public void setOptions(String fieldId, List<System.SelectOption> options)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
options
Type: List<System.SelectOption>
The selectable options for a field in the preference form.

Return Value

Type: void

setSelectedOption(fieldId, optionValue)

For a picklist or radio button field on a preference form that has defined values, set the value entered in the optionValue field as the selected option.

Signature

public void setSelectedOption(String fieldId, String optionValue)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
optionValue
Type: String
The value for the selected option.

Return Value

Type: void

setSelectedOptions(fieldId, options)

For an existing checkbox field on a preference form that has defined values, set the values entered in the options field as the selected options. This requires the field on the form to have defined options with a set value.

Signature

public void setSelectedOptions(String fieldId, List<String> options)

Parameters

fieldId
Type: String
Identifies the checkbox field in the preference form.
options
Type: List<String>
The selected options for a field in the preference form.

Return Value

Type: void

setTextHint(fieldId, hintText)

Set the hint text inside a text input field. The hint text tells the user what type of information to enter, like an email address.

Signature

public void setTextHint(String fieldId, String hintText)

Parameters

fieldId
Type: String
The ID of the text input field in the preference form.
hintText
Type: String
The hint text in the text input field.

Return Value

Type: void

setTextValue(fieldId, value)

Set the value of a text field in a preference form.

Signature

public void setTextValue(String fieldId, String value)

Parameters

fieldId
Type: String
Identifies a field in the preference form.
value
Type: String
Represents the value entered for the text field in a preference form.

Return Value

Type: void