TabControl Class — NXOpen Python API Reference 12.0.0 documentation

# TabControl Class

class `NXOpen.BlockStyler.``TabControl`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Tab Control layout

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
ActivePage | Returns or sets the ActivePage
Enable | Returns or sets the Enable.
Expanded | Returns or sets the Expanded
Group | Returns or sets the Group
HighQualityBitmap | Returns or sets the HighQualityBitmap
Label | Returns or sets the Label
Localize | Returns or sets the Localize
Members | Returns the Members
Name | Returns the name of the block or BlockID
RetainValue | Returns or sets the RetainValue
Show | Returns or sets the Visibility of block.
TabsPerRow | Returns or sets the TabsPerRow
Tag | Returns the Tag for this object.
Type | Returns the type of block

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetHiddenTabPages | Gets the HiddenTabPages.
GetProperties | Returns the properties of the block
SetHiddenTabPages | Sets the HiddenTabPages entered.

# Property Detail

## ActivePage

`TabControl.``ActivePage`

  Returns or sets the ActivePage

  `-------------------------------------`

  Getter Method

  Signature `ActivePage`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ActivePage`

  Parameters: | pageIndex (int) –

  New in version NX8.5.0.

  License requirements: None.

## HighQualityBitmap

`TabControl.``HighQualityBitmap`

  Returns or sets the HighQualityBitmap

  `-------------------------------------`

  Getter Method

  Signature `HighQualityBitmap`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HighQualityBitmap`

  Parameters: | highQuality (bool) –

  New in version NX8.5.0.

  License requirements: None.

## Localize

`TabControl.``Localize`

  Returns or sets the Localize

  `-------------------------------------`

  Getter Method

  Signature `Localize`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Localize`

  Parameters: | localize (bool) –

  New in version NX8.5.0.

  License requirements: None.

## Members

`TabControl.``Members`

  Returns the Members

  `-------------------------------------`

  Getter Method

  Signature `Members`

  Returns: |
  Return type: | `NXOpen.BlockStyler.PropertyList`

  New in version NX8.5.0.

  License requirements: None.

## RetainValue

`TabControl.``RetainValue`

  Returns or sets the RetainValue

  `-------------------------------------`

  Getter Method

  Signature `RetainValue`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RetainValue`

  Parameters: | retain (bool) –

  New in version NX8.5.0.

  License requirements: None.

## TabsPerRow

`TabControl.``TabsPerRow`

  Returns or sets the TabsPerRow

  `-------------------------------------`

  Getter Method

  Signature `TabsPerRow`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TabsPerRow`

  Parameters: | numTabs (int) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## GetHiddenTabPages

`TabControl.``GetHiddenTabPages`

  Gets the HiddenTabPages.

  This method returns an integer array of the HiddenTabPages. If the number of Tab Pages defined is 5 for a Tab Control, they will be indexed 0 to 4. If the first and third Tab Pages are hidden, the result returned will be [ 0, -1, 2, -1, -1 ]. Any negative integer value will show the Tab Page, using -1 simply to demonstrate.

  Signature `GetHiddenTabPages()`

  Returns: |
  Return type: | list of int

  New in version NX10.0.1.

  License requirements: None.

## SetHiddenTabPages

`TabControl.``SetHiddenTabPages`

  Sets the HiddenTabPages entered.

  If the number of Tab Pages defined is 5 for a Tab Control, they will be indexed 0 to 4. Entering an array of [ 0, -1, 2, -1, -1 ] will result in the first and third Tab Pages being hidden. Any negative integer value will show the Tab Page, using -1 simply to demonstrate.

  Signature `SetHiddenTabPages(hiddenTabs)`

  Parameters: | hiddenTabs (list of int) – Array of Tab Pages defined. To hide a Tab Page, value entered has to map directly to the index being set.

  New in version NX10.0.1.

  License requirements: None.