Share this page

# TabControl

## SAPGUI. TabControl

## new TabControl(propsopt) → {TabControl}

The description of a TabControl test object.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`props` | Object | <optional> | Initializes a TabControl test object using the supplied property bag.

##### Returns:

the description object that was initialized.

Type
  TabControl

# Methods

## absoluteLocation(locationopt) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`location` | Point | <optional> | When provided, this method acts as a setter and sets the absoluteLocation value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.

Type
  Point | Description

## id(idopt) → {string|Description}

The element's unique identifier in text format.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`id` | string | <optional> | When provided, this method acts as a setter and sets the id value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored id value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## isEnabled(isEnabledopt) → {boolean|Description}

Indicates whether the tab strip can accept user input.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`isEnabled` | boolean | <optional> | When provided, this method acts as a setter and sets the isEnabled value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.

Type
  boolean | Description

## location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`location` | Point | <optional> | When provided, this method acts as a setter and sets the location value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.

Type
  Point | Description

## name(nameopt) → {string|Description}

The name of the element.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`name` | string | <optional> | When provided, this method acts as a setter and sets the name value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## selectedTab(selectedTabopt) → {string|Description}

The name of the selected tab.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`selectedTab` | string | <optional> | When provided, this method acts as a setter and sets the selectedTab value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored selectedTab value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## size(sizeopt) → {Size|Description}

The object's size in pixels.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`size` | Size | <optional> | When provided, this method acts as a setter and sets the size value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.

Type
  Size | Description

## tabs(tabsopt) → {Array.<string>|Description}

The list of the items in the status bar.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`tabs` | Array.<string> | <optional> | When provided, this method acts as a setter and sets the tabs value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored tabs value; otherwise it returns 'this' for use with the builder pattern.

Type
  Array.<string> | Description

## tabsCount(tabsCountopt) → {number|Description}

The number of tabs contained in the tab strip.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`tabsCount` | number | <optional> | When provided, this method acts as a setter and sets the tabsCount value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored tabsCount value; otherwise it returns 'this' for use with the builder pattern.

Type
  number | Description

## text(textopt) → {string|Description}

The text string associated with the tab strip.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`text` | string | <optional> | When provided, this method acts as a setter and sets the text value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## tooltip(tooltipopt) → {string|Description}

The value of the tab strip's tooltip.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`tooltip` | string | <optional> | When provided, this method acts as a setter and sets the tooltip value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored tooltip value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## type(typeopt) → {SAPGUI.ComponentType|Description}

The numeric identification of the GUI component type.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`type` | SAPGUI.ComponentType | <optional> | When provided, this method acts as a setter and sets the type value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored type value; otherwise it returns 'this' for use with the builder pattern.

Type
  SAPGUI.ComponentType | Description

Tips to improve your search results... UFT Developer JavaScript SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: