GefObject.TabOrder (property)

Gets and sets the tab order index of the object.
Syntax: long = object.TabOrder
object.TabOrder = long
Description: This property corresponds to the Tab Order field on the General property page.

The tab order only applies to objects that can be clicked on. This includes all objects with Mouse events, slider or text setpoints, as well as certain OLE objects. These objects are called "action objects".

You can only change the tab order of action objects. If an object is not an action object, it will report a tab order of -1. You cannot assign a tab order of -1 to an object.

The value of the tab order index will be between 0 and the number of action objects (minus one). If you attempt to set the tab order to a number that is too big, the object will be put at the end of the tab order. If you attempt to set the tab order to a 0 or a negative number, the object will be put at the beginning of the tab order. When you set the tab order of an object, the tab order of other objects will be changed accordingly.

The tab order determines the tab order of objects within this container. That is, if you are examining the tab order of some objects in a group, the tab order only determines the tab order within that group. The group object itself has its own tab order within its parent object.

Example:

Sub GefObject_TabOrder()
    
    Dim oCimObj As GefObject
    
    Set oCimObj = CimGetObject
    
    MsgBox "This object has a tab index of " & oCimObj.TabOrder
    
End Sub