<< Click to Display Table of Contents >> Navigation:  Interactive Objects > VpeGetControlTabIndex

Returns the Tab-Index of the specified control. Each control has assigned a unique Tab-Index. The Tab-Index determines the order in which the user can Tab through the controls: if the user presses the Tab key on the keyboard, VPE will search the whole document for the control with the next higher Tab-Index and set the focus on it. The reverse is done, if the user presses Shift + Tab ("Backtab").

If you are using templates, the Tab-Index can be assigned to each object using dycodoc (in the object's properties dialog). If you are creating Controls by code (e.g. by calling VpeFormFieldControl(), VpeCheckbox(), etc.), VPE assigns automatically a Tab-Index to each object in the order of creation.

long VpeGetControlTabIndex(

VpeHandle hControl,

)

VpeHandle hControl

Control Handle

Returns:

The Tab-Index of the specified control.

Remarks:

The function allows that hControl may be NULL, in this case the function returns 0.

 

See Also:

"Interactive Documents" in the Programmer's Manual.