ApexPage

Represents a single Visualforce page.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields

Field Details
ApiVersion
Type
double
Properties
Create, Filter, Sort, Update
Description
The API version for this page. Every page has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0.
ControllerKey
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier for the controller associated with this page:
  • If the ControllerType parameter is set to Standard or StandardSet, this value is the name of the sObject that defines the controller.
  • If the ControllerType parameter is set to Custom, this value is the name of the Apex class that defines the controller.
ControllerType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of controller associated with this Visualforce page. Possible values include:
  • Not Specified, for pages defined with neither a standardController nor a controller attribute on the <apex:page> tag
  • Standard, for pages defined with the standardController attribute on the <apex:page> tag
  • StandardSet, for pages defined using the standardController and recordSetVar attribute on the <apex:page> tag
  • Custom, for pages defined with the controller attribute on the <apex:page> tag
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the Visualforce page.
isAvailableInTouch
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if Visualforce tabs associated with the Visualforce page can be used in the Salesforce1 app (true) or not (false). (Use of this field for Salesforce Touch is deprecated.) This field is available in API version 27.0 and later.

Standard object tabs that are overridden with a Visualforce page aren’t supported in Salesforce1, even if you set this field for the page. The default Salesforce1 page for the object is displayed instead of the Visualforce page.

IsConfirmationTokenRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether GET requests for the page require a CSRF confirmation token (true) or not (false). This field is available in API version 28.0 and later.

If you change this field’s value from false to true, links to the page require a CSRF token to be added to them, or the page will be inaccessible.

Markup
Type
textarea
Properties
Create, Update
Description
The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the content of the page.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text used to identify the Visualforce page in the Setup area of Salesforce. The Label is Label.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of this Visualforce page.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

Usage

Use Visualforce pages to add custom content that extends the base Salesforce application functionality. All users in Visualforce-enabled organizations can view Visualforce pages, but the “Customize Application” permission is required to create or update them.

For information, see the Visualforce Developers Guide.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.