--- schema_version: "1" id: 5220707bf39435c79b64d0e5fa5aeae4589681a17b03cb78ff343a0759b264fc title: StandardController Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_pages_standardcontroller.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm source_site: developer.salesforce.com content_type: documentation content_hash: ac8e5ac637798a1fa89689a311ca3e679705bf38baf6c542bda936eefe39f50e description: Use a StandardController when defining an extension for a standard controller.Creates a new instance of the ApexPages.StandardController class for the specified standard or custom object.When a Visualforce page is loaded, the fields accessible to the page are based on the fields referenced in the Visualforce markup. This method adds a reference to each field specified in fieldNames so that the controller can explicitly access those fields as well.Returns the PageReference of the cancel page.Deletes record and returns the PageReference of the delete page.Returns the PageReference of the standard edit page.Returns the ID of the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL.Returns the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. Forces the controller to reacquire access to newly referenced fields. Any changes made to the record prior to this method call are discarded. Saves changes and returns the updated PageReference.Returns the PageReference object of the standard detail page. --- # StandardController Class Use a StandardController when defining an extension for a standard controller. ## Namespace [ApexPages](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_ApexPages.htm "The ApexPages namespace provides classes used in Visualforce controllers.") ## Usage StandardController objects reference the pre-built Visualforce controllers provided by Salesforce. The only time it is necessary to refer to a StandardController object is when defining an extension for a standard controller. StandardController is the data type of the single argument in the extension class constructor. ## Instantiation You can instantiate a StandardController in the following way: ApexPages.StandardController sc = new ApexPages.StandardController(sObject); ## Example The following example shows how a StandardController object can be used in the constructor for a standard controller extension: public class myControllerExtension { private final Account acct; // The extension constructor initializes the private member // variable acct by using the getRecord method from the standard // controller. public myControllerExtension(ApexPages.StandardController stdController) { this.acct = (Account)stdController.getRecord(); } public String getGreeting() { return 'Hello ' + acct.name + ' (' + acct.id + ')'; } } The following Visualforce markup shows how the controller extension from above can be used in a page: {!greeting}

- **[StandardController Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_constructors)** - **[StandardController Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_methods)** ## StandardController Constructors The following are constructors for StandardController. - **[StandardController(controllerSObject)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_ctor)** Creates a new instance of the ApexPages.StandardController class for the specified standard or custom object. ### StandardController(controllerSObject) Creates a new instance of the ApexPages.StandardController class for the specified standard or custom object. #### Signature public StandardController(SObject controllerSObject) #### Parameters - **controllerSObject**: Type: SObject A standard or custom object. ## StandardController Methods The following are methods for StandardController. All are instance methods. - **[addFields(fieldNames)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_addFields)** When a Visualforce page is loaded, the fields accessible to the page are based on the fields referenced in the Visualforce markup. This method adds a reference to each field specified in fieldNames so that the controller can explicitly access those fields as well. - **[cancel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_cancel)** Returns the PageReference of the cancel page. - **[delete()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_delete)** Deletes record and returns the PageReference of the delete page. - **[edit()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_edit)** Returns the PageReference of the standard edit page. - **[getId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_getId)** Returns the ID of the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. - **[getRecord()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_getRecord)** Returns the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. - **[reset()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_reset)** Forces the controller to reacquire access to newly referenced fields. Any changes made to the record prior to this method call are discarded. - **[save()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_save)** Saves changes and returns the updated PageReference. - **[view()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_pages_standardcontroller.htm#apex_ApexPages_StandardController_view)** Returns the PageReference object of the standard detail page. ### addFields(fieldNames) When a Visualforce page is loaded, the fields accessible to the page are based on the fields referenced in the Visualforce markup. This method adds a reference to each field specified in fieldNames so that the controller can explicitly access those fields as well. #### Signature public Void addFields(List fieldNames) #### Parameters - **fieldNames**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> #### Return Value Type: Void #### Usage This method should be called before a record has been loaded—typically, it's called by the controller's constructor. If this method is called outside of the constructor, you must use the reset() method before calling addFields(). The strings in fieldNames can either be the API name of a field, such as AccountId, or they can be explicit relationships to fields, such as something\_\_r.myField\_\_c. This method is only for controllers used by dynamicVisualforce bindings. ### cancel() Returns the PageReference of the cancel page. #### Signature public System.PageReference cancel() #### Return Value Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") ### delete() Deletes record and returns the PageReference of the delete page. #### Signature public System.PageReference delete() #### Return Value Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") ### edit() Returns the PageReference of the standard edit page. #### Signature public System.PageReference edit() #### Return Value Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") ### getId() Returns the ID of the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. #### Signature public String getId() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getRecord() Returns the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. #### Signature public SObject getRecord() #### Return Value Type: [sObject](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_sobject.htm#apex_methods_system_sobject "Contains methods for the sObject data type.") #### Usage Note that only the fields that are referenced in the associated Visualforce markup are available for querying on this SObject. All other fields, including fields from any related objects, must be queried using a SOQL expression. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note_tip.png) #### Tip You can work around this restriction by including a hidden component that references any additional fields that you want to query. Hide the component from display by setting the component's rendered attribute to false. #### Example ### reset() Forces the controller to reacquire access to newly referenced fields. Any changes made to the record prior to this method call are discarded. #### Signature public Void reset() #### Return Value Type: Void #### Usage This method is only used if addFields is called outside the constructor, and it must be called directly before addFields. This method is only for controllers used by dynamicVisualforce bindings. ### save() Saves changes and returns the updated PageReference. #### Signature public System.PageReference save() #### Return Value Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.") ### view() Returns the PageReference object of the standard detail page. #### Signature public System.PageReference view() #### Return Value Type: [System.PageReference](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_system_pagereference.htm "A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.")