Share via


DockPosition Property

Indicates the docking position for a user-defined ToolBar object or Form object. Read-only at design time and run time.

Object.DockPosition [= nPosition]

Return Value

  • nPosition
    Indicates the docking position for a toolbar or form.

    The following table lists the values for nPosition.

    nPosition

    Description

    –1

    Not docked

    0

    Top

    1

    Left

    2

    Right

    3

    Bottom

    4

    Tabbed (forms only)

    5

    Link-docked (forms only)

    Note

    A value of 5 indicates that a form is part of link-docked container. You can dock a tab-docked window with a link-docked container; therefore, it is recommended that you obtain additional docking information using the ADOCKSTATE( ) function and GetDockState method.

    Remarks

    Applies To: Form Object | ToolBar Object

    To retrieve detailed docking information, see ADOCKSTATE( ) Function and GetDockState Method.

    See Also

    Tasks

    How to: Dock Windows

    How to: Dock Forms

    Reference

    Docked Property

    Other Resources

    Properties (Visual FoxPro)