Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

ActionOverride

Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can only access ActionOverride by accessing its encompassing CustomObject.

Declarative Metadata File Suffix and Directory Location

Action overrides are defined as part of a standard or custom object.

Version

Action overrides are available in API version 18.0 and later. Beginning in Summer ’13, action overrides can be applied to both standard or custom objects. Previously, action overrides only applied to custom objects.

Fields

Unless otherwise noted, all fields are createable, filterable, and nillable.

Field Name Field Type Description
actionName string Required. The possible values are the same as the actions you can override:
  • accept
  • clone
  • delete
  • edit
  • list
  • new
  • tab
  • view
comment string Any comments you want associated with the override.
content string Set this field if type is set to scontrol or visualforce. It refers to the name of the s-control or Visualforce page to use as the override. To reference installed components, use the format of Component_ namespace__Component_name.
skipRecordTypeSelect boolean Set this field to true if you prefer that any new records created by this action override aren’t forwarded to the record type selection page. This field is only valid if the actionName is a “create” type (like new), and type is set to visualforce. This field is only available in API version 21.0 and later.
type ActionOverrideType (enumeration of type string) Required. Represents the type of action override. Valid values are described in ActionOverrideType.

ActionOverrideType

ActionOverrideType is an enumeration of type string that defines which kind of action override to use. The valid values are:

  • default—The override uses a custom override provided by an installed package. If there isn’t one available, the standard Salesforce behavior is used.
  • scontrol—The override uses behavior from an s-control.
  • standard—The override uses regular Salesforce behavior.
  • visualforce—The override uses behavior from a Visualforce page.

Declarative Metadata Sample Definitions

You can define an action like this:
With the previous definition, calling retrieve() presents:
If a subscriber installed a package with the previous metadata, you can override the behavior by editing the XML. For example, if you want the regular Salesforce behavior, use: