Returns information in an array about the dock state of a form.

NoteNote

To use GetDockState, the form's Dockable property must be set to 1.

Form.GetDockState(ArrayName)

Parameters

ArrayName

Returns a single row, six-column array containing dock information for a form.

NoteNote

You must first create the array before passing an array name.

The following table describes the array returned by GetDockState.

Column Description

1

Name of the docking form.

2

Dock state:

1 - Docked

2 - Not docked

3

Dock position.

For values, see DockPosition Property.

4

Target form, or caption of the form to which the specified form is docked.

5

Object reference for the docking form.

6

Object reference for the target window or form.

Expand imageReturn Value

Expand imageRemarks

Expand imageSee Also