Interactive Objects > ControlTabIndex

Returns / modifies 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 FormFieldControl(), Checkbox(), etc.), VPE assigns automatically a Tab-Index to each object in the order of creation.

You can use this property to modify the Tab-Order of a document. But special care must be taken: make sure that you don't assign one and the same Tab-Index to more than one object. The Tab-Index must be unique for each object in the document.

This property belongs to TVPEObject.

property long VPE.ControlTabIndex

read / write; runtime only

Possible Values:

The Tab-Index of the specified control. If this property is used for a TVPEObject which does not represent a control, it will return null für reading and it will do nothing if you assign a value to it.

Remarks:

The values 0 and -1 (0xffffffff) are reserved. You can not set the Tab-Index to either value, in such case the original Tab-Index remains unchanged.

You may access this property also for a VPE object that has a NULL-Handle, in this case a write access does nothing and a read access returns zero.