SECFrameDockingFeature::DockNode

Dock a dockable layout node to the associated frame window

Defined in: FrameDock.cpp

Syntax

DockNode(SECLayoutNode* pNode,DWORD dwDockSite,int nSize,BOOL bNewLine)

DockNode(SECLayoutNode* pNode,SECDockInsertionConstraints& Cnstr)

Return Value

TRUE on successful dock, otherwise FALSE

Parameters

pNode

Node to be docked.

dwDockSite

Border target for initial docking. Must be one of the following:

SEC_DOCK_LEFT - Dock to the left border of the frame
SEC_DOCK_TOP - Dock to the top border of the frame
SEC_DOCK_RIGHT - Dock to the right border of the frame
SEC_DOCK_BOTTOM - Dock to the bottom border of the frame

nSize

Initial size of this newly docked node. If docking to top or bottom, this size will be the node's width. If docking to left or right, this size will be the node's height. If bNewLine is TRUE, this size will be the height of the new line (docking top/bottom) or width of the new line (docking left/right) If nSize is less than zero (default), then average size will be used.

bNewLine

If true, insertion will occur in a new grid line, a new column if left/right border dock, or a new row if top/bottom border dock.

Cnstr

Dock given these insertion constraints. This function may modify the value of this object to optimize for subsequent insertions.