DescribeTabResult Class

Contains tab metadata information for a tab in a standard or custom app available in the Salesforce user interface.

Namespace

Schema

Usage

The getTabs method of the Schema.DescribeTabSetResult returns a list of Schema.DescribeTabResult objects that describe the tabs of one app.

The methods in the Schema.DescribeTabResult class can be called using their property counterparts. For each method starting with get, you can omit the get prefix and the ending parentheses () to call the property counterpart. For example, tabResultObj.label is equivalent to tabResultObj.getLabel(). Similarly, for each method starting with is, omit the is prefix and the ending parentheses (). For example, tabResultObj.isCustom is equivalent to tabResultObj.custom.

DescribeTabResult Methods

The following are methods for DescribeTabResult. All are instance methods.

getColors()

Returns a list of color metadata information for all colors associated with this tab. Each color is associated with a theme and context.

Signature

public List<Schema.DescribeColorResult> getColors()

Return Value

Type: List<Schema.DescribeColorResult>

getIconUrl()

Returns the URL for the main 32 x 32-pixel icon for a tab. This icon corresponds to the current theme (theme3) and appears next to the heading at the top of most pages.

Signature

public String getIconUrl()

Return Value

Type: String

getIcons()

Returns a list of icon metadata information for all icons associated with this tab. Each icon is associated with a theme and context.

Signature

public List<Schema.DescribeIconResult> getIcons()

Return Value

Type: List<Schema.DescribeIconResult>

getLabel()

Returns the display label of this tab.

Signature

public String getLabel()

Return Value

Type: String

getMiniIconUrl()

Returns the URL for the 16 x 16-pixel icon that represents a tab. This icon corresponds to the current theme (theme3) and appears in related lists and other locations.

Signature

public String getMiniIconUrl()

Return Value

Type: String

getSobjectName()

Returns the name of the sObject that is primarily displayed on this tab (for tabs that display a particular SObject).

Signature

public String getSobjectName()

Return Value

Type: String

getUrl()

Returns a fully qualified URL for viewing this tab.

Signature

public String getUrl()

Return Value

Type: String

isCustom()

Returns true if this is a custom tab, or false if this is a standard tab.

Signature

public Boolean isCustom()

Return Value

Type: Boolean