ObjectDCL Banner

Tab_GetCurSel Method

Description

This method will return the current tab selection.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.

Return Values

Returns the following according to the situation:

  • Integer describing the index of the current tab.
  • Nil if the control is not found or is not visible.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tab_GetCurrentSel 
		MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_Tab_GetCurrentSel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

TabControl.

Example

CopyCode imageCopy Code
; Get the currently selected tab
(Setq rValue (Odcl_Tab_GetCurrentSel MyProject_MyForm_MyControl))

See Also

Tab_SetCurSel