Makes the specified tab the new active tab.

C

int SftTabs_SetCurrentTab(HWND hwndCtl, int iTab);

C++

int CSftTabs::SetCurrentTab(int iTab);

Parameters

hwndCtl

The window handle of the tab control.

iTab

The zero-based index of the tab to be activated. All tabs can be deactivated by specifying -1 (based on the settings defined by SetAllowAllInactive).

Returns

The return value is the index of the new active tab, otherwise -1 is returned.

Comments

The SetCurrentTab function makes the specified tab the new active tab.

When using this function to activate a new tab, the normal tab switching mechanism takes place, such as calling the SFTTABS_TABCALLBACK tab callback function, the CSftTabsPage::AllowSwitch or CSftTabsWindowPage::AllowSwitch member functions of the C++ based implementation of tabbed dialog.

A disabled tab cannot be activated. Use SetCurrentTabEx to activate a disabled tab.

Example

This example makes the third tab the new active tab:

C

SftTabs_SetCurrentTab(hwndTab, 2); 

C++

m_Tab.SetCurrentTab(2);

See Also  C/C++ API  |  C++ Classes  |  Notifications