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
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
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_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
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup 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
DataRow Class
DesignTimePageContext Class
DynamicPickList Class
DynamicPickList Methods
DynamicPickListRows Class
Wave Namespace
Appendices
PDF

Newer Version Available

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

DynamicPickList Class

An abstract class, used to display the values of a picklist in a Lightning component on a Lightning page.

Namespace

VisualEditor

Usage

To use this class as the datasource of a picklist in a Lightning component, it must be extended by a custom Apex class and then that class must be called in the component’s design file.

Example

Here’s an example of a custom Apex class extending the VisualEditor.DynamicPickList class.
Here’s an example of how the custom Apex class gets called in a design file so that the picklist appears in the Lightning component.

DynamicPickList Methods

The following are methods for DynamicPickList.

clone()

Makes a duplicate copy of the VisualEditor.DynamicPicklist object.

Signature

public Object clone()

Return Value

Type: Object

getDefaultValue()

Returns the picklist item that is set as the default value for the picklist.

Signature

public VisualEditor.DataRow getDefaultValue()

Return Value

Type: VisualEditor.DataRow

getLabel(attributeValue)

Returns the user-facing label for a specified picklist value.

Signature

public String getLabel(Object attributeValue)

Parameters

attributeValue
Type: Object
The value of the picklist item.

Return Value

Type: String

getValues()

Returns the list of picklist item values.

Signature

public VisualEditor.DynamicPickListRows getValues()

Return Value

Type: VisualEditor.DynamicPickListRows

isValid(attributeValue)

Returns the valid state of the picklist item’s value. A picklist value is considered valid if it’s a part of any VisualEditor.DataRow in the VisualEditor.DynamicPickListRows returned by getValues().

Signature

public Boolean isValid(Object attributeValue)

Parameters

attributeValue
Type: Object
The value of the picklist item.

Return Value

Type: Boolean