Share via


CDockSite Class

This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.

Provides functionality for arranging panes that are derived from the CPane Class into sets of rows.

class CDockSite: public CBasePane

Members

Public Methods

Name

Description

CDockSite::AddRow

 

CDockSite::AdjustDockingLayout

  (Overrides CBasePane::AdjustDockingLayout.)

CDockSite::AdjustLayout

  (Overrides CBasePane::AdjustLayout.)

CDockSite::AlignDockSite

 

CDockSite::CalcFixedLayout

  (Overrides CBasePane::CalcFixedLayout.)

CDockSite::CanAcceptPane

  (Overrides CBasePane::CanAcceptPane.)

CDockSite::CreateEx

  (Overrides CBasePane::CreateEx.)

CDockSite::CreateRow

 

CDockSite::DockPane

  (Overrides CBasePane::DockPane.)

CDockSite::DoesAllowDynInsertBefore

  (Overrides CBasePane::DoesAllowDynInsertBefore.)

CDockSite::FindRowIndex

 

CDockSite::FixupVirtualRects

 

CDockSite::GetDockSiteID

 

CDockSite::GetDockSiteRowsList

 

CDockSite::IsAccessibilityCompatible

  (Overrides CBasePane::IsAccessibilityCompatible.)

CDockSite::IsDragMode

 

CDockSite::IsLastRow

 

CDockSite::IsRectWithinDockSite

 

CDockSite::IsResizable

  (Overrides CBasePane::IsResizable.)

CDockSite::MovePane

 

CDockSite::OnInsertRow

 

CDockSite::OnRemoveRow

 

CDockSite::OnResizeRow

 

CDockSite::OnSetWindowPos

 

CDockSite::OnShowRow

 

CDockSite::OnSizeParent

 

CDockSite::PaneFromPoint

Returns a pane that is docked in the dock site at the point specified by the given parameter.

CDockSite::DockPaneLeftOf

Docks a pane to the left of another pane.

CDockSite::FindPaneByID

Returns the pane that is identified by the given ID.

CDockSite::GetPaneList

Returns a list of panes that are docked at the dock site.

CDockSite::RectSideFromPoint

 

CDockSite::RemovePane

 

CDockSite::RemoveRow

 

CDockSite::ReplacePane

 

CDockSite::RepositionPanes

 

CDockSite::ResizeDockSite

 

CDockSite::ResizeRow

 

CDockSite::ShowPane

Shows the pane.

CDockSite::ShowRow

 

CDockSite::SwapRows

 

Remarks

The framework creates CDockSite objects automatically when you call CFrameWndEx::EnableDocking. Dock site windows are positioned at the edge of the client area on the main frame window.

You usually do not have to call the services provided by the dock site because CFrameWndEx Class handles these services.

Example

The following example demonstrates how to create an object of the CDockSite class.

 AFX_DOCKSITE_INFO info;
    CDockSite* pDockBar = (CDockSite*) info.pDockBarRTC->CreateObject();

Inheritance Hierarchy

CObject   CCmdTarget      CWnd

         CBasePane            CDockSite

Requirements

Header: afxDockSite.h

See Also

Reference

Hierarchy Chart

CBasePane Class

Other Resources

MFC Classes