Newer Version Available

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

DescribeTab

Returns a describeTabSetResult object.

The describeTabs() call returns a describeTabSetResult object, of which DescribeTab is a property:

Name Type Description
colors DescribeColor[] Array of color information used for a tab. This field is available in API version 29.0 and later.
custom boolean true if this is a custom tab, false if this is a standard tab.
iconUrl string The URL for the main 32x32 pixel icon for a tab. This icon appears next to the heading at the top of most pages. This icon URL corresponds to the 32x32 icon used for the Salesforce Classic 2010 user interface theme.
icons DescribeIcon[] Array of icon information used for a tab. This field is available in API version 29.0 and later.
label string The display label for this tab.
miniIconUrl string The URL for the 16x16 pixel icon that represents a tab. This icon appears in related lists and other locations. This icon URL corresponds to the 16x16 icon used for the current Salesforce theme, introduced in Spring ’10.
name string The API name of the tab.
sobjectName string The name of the sObject that is primarily displayed on this tab (for tabs that display a particular sObject). For a list of objects, see Standard Objects.
url string A fully qualified URL for viewing this tab.