Share via


CBasePane::DockToFrameWindow

Docks a dockable pane to a frame.

virtual BOOL DockToFrameWindow(
   DWORD dwAlignment,
   LPCRECT lpRect = NULL,
   DWORD dwDockFlags = DT_DOCK_LAST,
   CBasePane* pRelativeBar = NULL,
   int nRelativeIndex = -1,
   BOOL bOuterEdge = FALSE
);

Parameters

  • [in] dwAlignment
    The side of the parent frame that you want to dock the pane to.

  • [in] lpRect
    The desired size.

  • [in] dwDockFlags
    Ignored.

  • [in] pRelativeBar
    Ignored.

  • [in] nRelativeIndex
    Ignored.

  • [in] bOuterEdge
    If TRUE and there are other dockable panes at the side specified by dwAlignment, the pane is docked outside the other panes, closer to the edge of the parent frame. If FALSE, the pane is docked closer to the center of the client area.

Return Value

TRUE if the method was successful; otherwise FALSE.

Remarks

This method fails if a pane divider (CPaneDivider Class) cannot be created. Otherwise, it always returns TRUE.

Requirements

Header: afxbasepane.h

See Also

Reference

CBasePane Class

Hierarchy Chart