Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace (Beta)
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
DataRow Class
DesignTimePageContext Class
DesignTimePageContext Properties
DesignTimePageContext Methods
DynamicPickList Class
DynamicPickListRows Class
wave Namespace
Appendices
PDF

Newer Version Available

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

DesignTimePageContext Class

An abstract class that provides context information about a Lightning page. It can be used to help define the values of a picklist in a Lightning component on a Lightning page based on the page’s type and the object with which it’s associated.

Namespace

VisualEditor

Usage

To use this class, create a parameterized constructor in the custom Apex class that extends VisualEditor.DynamicPickList.

Example

Here’s an example of a custom Apex class extending the VisualEditor.DynamicPickList class. It includes VisualEditor.DesignTimePageContext to define a picklist value that is available only if the page type is HomePage.

DesignTimePageContext Properties

The following are properties for DesignTimePageContext.

entityName

The API name of the sObject that a Lightning page is associated with, such as Account, Contact or Custom_object__c. Not all Lightning pages are associated with objects.

Signature

public String entityName {get; set;}

Property Value

Type: String

pageType

The type of Lightning page, such as HomePage, AppPage, or RecordPage.

Signature

public String pageType {get; set;}

Property Value

Type: String

DesignTimePageContext Methods

The following are methods for DesignTimePageContext.

clone()

Makes a duplicate copy of the VisualEditor.DesignTimePageContext object.

Signature

public Object clone()

Return Value

Type: Object