Newer Version Available

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

CustomTab

Represents a custom tab.

This object is available in the Tooling API version 33.0 and later.

Supported Calls

create(), delete(), query(), retrieve(), update()

Fields

Field Details
Description
Type
string
Properties
Filter, Nillable, Sort
Description
The tab’s description.
DeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The developer’s internal name for the custom tab.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The name of the tab. The value of this field depends on the type of tab, and the API version.
  • For custom object tabs, the fullName is the developer-assigned name of the custom object (MyCustomObject__c, for example).
  • For Web tabs, the fullName is the developer-assigned name of the tab (MyWebTab, for example).
HasSidebar
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates if the tab displays the sidebar panel.
MasterLabel
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
Required. The label for the custom tab, which displays in Setup.
Metadata
Type
CustomTabMetadata
Properties
Create, Nillable, Update
Description
Custom tab metadata.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace of the package of which the custom tab is a part.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of custom tab. Valid values are:
  • apexPage
  • aura
  • customObject
  • flexiPage
  • sControl
  • url
Url
Type
string
Properties
Filter, Nillable, Sort
Description
The URL for the external web-page to embed in this tab.