Dela via

CDockablePane-klass

  • Artikel

Implementerar ett fönster som antingen kan dockas i en dockningsplats eller inkluderas i ett fönster med flikar.

Syntax

class CDockablePane : public CPane

Medlemmar

Offentliga konstruktorer

Namn Beskrivning
CDockablePane::CDockablePane Konstruerar och initierar ett CDockablePane objekt.

Offentliga metoder

Namn Beskrivning
CDockablePane::AttachToTabWnd Bifogar en ruta till ett annat fönster. Då skapas ett fönster med flikar.
CDockablePane::CalcFixedLayout Returnerar storleken på rutans rektangel.
CDockablePane::CanAcceptMiniFrame Avgör om den angivna miniramen kan dockas till fönstret.
CDockablePane::CanAcceptPane Avgör om ett annat fönster kan dockas till det aktuella fönstret.
CDockablePane::CanAutoHide Avgör om fönstret har stöd för automatiskt döljningsläge. (Åsidosätter CBasePane::CanAutoHide.)
CDockablePane::CanBeAttached Avgör om det aktuella fönstret kan dockas till ett annat fönster.
CDockablePane::ConvertToTabbedDocument Konverterar ett eller flera dockbara fönster till MDI-flikar.
CDockablePane::CopyState Kopierar tillståndet för ett dockbart fönster.
CDockablePane::Create Skapar Windows-kontrollen och kopplar den till objektet CDockablePane.
CDockablePane::CreateDefaultPaneDivider Skapar en standardavdelare för fönstret när den dockas till ett ramfönster.
CDockablePane::CreateEx Skapar Windows-kontrollen och kopplar den till objektet CDockablePane.
CDockablePane::CreateTabbedPane Skapar ett fönster med flikar från det aktuella fönstret.
CDockablePane::DockPaneContainer Dockar en container till fönstret.
CDockablePane::DockPaneStandard Dockar ett fönster med hjälp av dispositions-dockning (standard).
CDockablePane::DockToFrameWindow Används internt. Om du vill docka ett fönster använder du CPane::DockPane eller CDockablePane::DockToWindow.
CDockablePane::DockToRecentPos Dockar ett fönster till den lagrade senaste dockningspositionen.
CDockablePane::DockToWindow Dockar ett dockningsfönster till ett annat dockningsfönster.
CDockablePane::EnableAutohideAll Aktiverar eller inaktiverar läget dölj automatiskt för det här fönstret tillsammans med andra fönster i containern.
CDockablePane::EnableGripper Visar eller döljer bildtexten (griparen).
CDockablePane::GetAHRestoredRect Anger fönstrets position när den visas i läget dölj automatiskt.
CDockablePane::GetAHSlideMode Hämtar det automatiska dölj bildläget för fönstret.
CDockablePane::GetAutoHideButton Används internt.
CDockablePane::GetAutoHideToolBar Används internt.
CDockablePane::GetCaptionHeight Returnerar höjden på den aktuella bildtexten.
CDockablePane::GetDefaultPaneDivider Returnerar standardfönstrets avdelare för fönstrets container.
CDockablePane::GetDockingStatus Avgör möjligheten för ett fönster att dockas baserat på den angivna pekarplatsen.
CDockablePane::GetDragSensitivity Returnerar drakänsligheten för ett dockningsfönster.
CDockablePane::GetLastPercentInPaneContainer Hämtar procentandelen utrymme som ett fönster upptar i containern.
CDockablePane::GetTabArea Hämtar flikområdet för fönstret.
CDockablePane::GetTabbedPaneRTC Returnerar runtime-klassinformationen om ett fönster med flikar som skapas när ett annat fönster dockar till det aktuella fönstret.
CDockablePane::HasAutoHideMode Anger om ett dockningsfönster kan växlas till läget dölj automatiskt.
CDockablePane::HitTest Anger den specifika platsen i ett fönster där användaren klickar på en mus.
CDockablePane::IsAccessibilityCompatible Används internt.
CDockablePane::IsAutohideAllEnabled Anger om dockningsfönstret och alla andra fönster i containern kan placeras i läget dölj automatiskt.
CDockablePane::IsAutoHideMode Avgör om ett fönster är i automatiskt döljläge.
CDockablePane::IsChangeState Används internt.
CDockablePane::IsDocked Avgör om det aktuella fönstret är dockat.
CDockablePane::IsHideInAutoHideMode Avgör beteendet för ett fönster som är i läget dölj automatiskt om det visas (eller döljs) genom att anropa ShowPane.
CDockablePane::IsInFloatingMultiPaneFrameWnd Anger om fönstret finns i ett ramfönster med flera fönster.
CDockablePane::IsResizable Anger om fönstret kan ändras.
CDockablePane::IsTabLocationBottom Anger om flikarna finns överst eller längst ned i fönstret.
CDockablePane::IsTracked Anger om en ruta dras av användaren.
CDockablePane::IsVisible Avgör om det aktuella fönstret är synligt.
CDockablePane::LoadState Används internt.
CDockablePane::OnAfterChangeParent Anropas av ramverket när den överordnade delen av ett fönster har ändrats. (Åsidosätter CPane::OnAfterChangeParent.)
CDockablePane::OnAfterDockFromMiniFrame Anropas av ramverket när ett flytande dockningsfält dockar i ett ramfönster.
CDockablePane::OnBeforeChangeParent Anropas av ramverket när det överordnade fönstret håller på att ändras. (Åsidosätter CPane::OnBeforeChangeParent.)
CDockablePane::OnBeforeFloat Anropas av ramverket när ett fönster håller på att flyta. (Åsidosätter CPane::OnBeforeFloat.)
CDockablePane::RemoveFromDefaultPaneDividier Ramverket anropar den här metoden när en ruta kopplas från.
CDockablePane::ReplacePane Ersätter fönstret med ett angivet fönster.
CDockablePane::RestoreDefaultPaneDivider Ramverket anropar den här metoden eftersom ett fönster deserialiseras för att återställa standardfönstrets avdelare.
CDockablePane::SaveState Används internt.
CDockablePane::Serialize Serialiserar fönstret. (Åsidosätter CBasePane::Serialize.)
CDockablePane::SetAutoHideMode Växlar dockningsfönstret mellan synligt och automatiskt dolt läge.
CDockablePane::SetAutoHideParents Anger knappen dölj automatiskt och verktygsfältet dölj automatiskt för fönstret.
CDockablePane::SetDefaultPaneDivider Används internt.
CDockablePane::SetLastPercentInPaneContainer Anger procentandelen utrymme som ett fönster upptar i containern.
CDockablePane::SetResizeMode Används internt.
CDockablePane::SetRestoredDefaultPaneDivider Anger den återställde standardfönstrets avdelare.
CDockablePane::SetTabbedPaneRTC Anger körningsklassinformationen för ett fönster med flikar som skapas när två fönster dockar tillsammans.
CDockablePane::ShowPane Visar eller döljer ett fönster.
CDockablePane::Slide Visar eller döljer en ruta med en glidande animering som endast visas när fönstret är i läget dölj automatiskt.
CDockablePane::ToggleAutoHide Växlar automatiskt döljläge. (Åsidosätter CPane::ToggleAutoHide .)
CDockablePane::UndockPane Kopplar bort en ruta från antingen huvudramsfönstret eller en miniframe-fönstercontainer.
CDockablePane::UnSetAutoHideMode Används internt. Om du vill ange läget dölj automatiskt använder du CDockablePane::SetAutoHideMode

Skyddade metoder

Namn Beskrivning
CDockablePane::CheckAutoHideCondition Avgör om dockningsfönstret är dolt (i läget dölj automatiskt).
CDockablePane::CheckStopSlideCondition Avgör när ett automatiskt dölj dockningsfönster ska sluta glida.
CDockablePane::DrawCaption Ritar dockningsfönstrets bildtext (gripare).
CDockablePane::OnPressButtons Anropas när användaren trycker på en annan bildtextknapp än knapparna AFX_HTCLOSE och AFX_HTMAXBUTTON.
CDockablePane::OnSlide Anropas av ramverket för att återge den automatiska dölj bildeffekten när fönstret antingen visas eller döljs.

Datamedlemmar

Namn Beskrivning
CDockablePane::m_bDisableAnimation Anger om automatisk dölj animering av det dockbara fönstret är inaktiverat.
CDockablePane::m_bHideInAutoHideMode Avgör hur fönstret fungerar när fönstret är i läget dölj automatiskt.
CDockablePane::m_nSlideSteps Anger animeringshastigheten i fönstret när den visas eller döljs när den är i läget dölj automatiskt.

Anmärkningar

CDockablePane implementerar följande funktioner:

  • Docka ett fönster till ett huvudramfönster.

  • Växla ett fönster till läget dölj automatiskt.

  • Koppla ett fönster till ett fönster med flikar.

  • Flytta en ruta i ett miniframe-fönster.

  • Docka ett fönster till ett annat fönster som svävar i ett miniframe-fönster.

  • Ändra storlek på ett fönster.

  • Läser in och sparar tillstånd för ett dockningsfönster.

    Not

    Tillståndsinformation sparas i Windows-registret.

  • Skapa ett fönster med eller utan bildtext. Bildtexten kan ha en textetikett och den kan fyllas med en toningsfärg.

  • Dra ett fönster medan innehållet i fönstret visas

  • Dra ett fönster medan en dra-rektangel visas.

Om du vill använda ett dockningsfönster i programmet härleder du din fönsterklass från klassen CDockablePane. Bädda antingen in det härledda objektet i huvudramens fönsterobjekt eller i ett fönsterobjekt som styr instansen av fönstret. Anropa sedan metoden CDockablePane::Create eller metoden CDockablePane::CreateEx när du bearbetar meddelandet WM_CREATE i huvudramsfönstret. Konfigurera slutligen fönstret genom att anropa CBasePane::EnableDocking, CBasePane::DockPaneeller CDockablePane::AttachToTabWnd.

Anpassningstips

Följande tips gäller för CDockablePane objekt:

  • Om du anropar CDockablePane::AttachToTabWnd för två icke-flikar, dockbara fönster, returneras en pekare till ett flikar i parametern ppTabbedControlBar. Du kan fortsätta att lägga till flikar i fönstret med flikar med hjälp av den här parametern.

  • Den typ av fönster med flikar som skapas av CDockablePane::AttachToTabWnd bestäms av CDockablePane-objektet i parametern pTabControlBarAttachTo. Du kan anropa CDockablePane::SetTabbedPaneRTC för att ange vilken typ av fönster med flikar som CDockablePane ska skapa. Standardtypen bestäms av dwTabbedStyle för CDockablePane::Create när du först skapar CDockablePane. Om dwTabbedStyle är AFX_CBRS_OUTLOOK_TABS är standardtypen CMFCOutlookBar Klass; om dwTabbedStyle är AFX_CBRS_REGULAR_TABS är standardtypen CTabbedPane klass.

  • Om du vill docka ett dockningsbart fönster till ett annat anropar du metoden CDockablePane::DockToWindow. Den ursprungliga rutan måste dockas någonstans innan du anropar den här metoden.

  • Medlemsvariabeln CDockablePane::m_bHideInAutoHideMode styr hur dockningsbara fönster fungerar i automatiskt döljningsläge när du anropar CDockablePane::ShowPane. Om den här medlemsvariabeln är inställd på TRUEdöljs dockbara fönsterrutor och deras knappar för automatisk döljning. Annars skjuter de in och ut.

  • Du kan inaktivera automatisk dölj animering genom att ange CDockablePane::m_bDisableAnimation medlemsvariabeln till TRUE.

Exempel

I följande exempel visas hur du konfigurerar ett CDockablePane objekt med hjälp av olika metoder i klassen CDockablePane. Exemplet illustrerar hur du aktiverar funktionen dölj alla automatiskt för det dockbara fönstret, aktiverar bildtexten eller griparen, aktiverar läget dölj automatiskt, visar fönstret och animerar ett fönster som är i läget dölj automatiskt. Det här kodfragmentet är en del av Visual Studio Demo-exempelexemplet.

// GetOwner is an inherited method.
CDockablePane *pParentBar = DYNAMIC_DOWNCAST(CDockablePane, GetOwner());

pParentBar->EnableAutohideAll();
pParentBar->EnableGripper(true);
pParentBar->SetAutoHideMode(true, CBRS_ALIGN_LEFT);
pParentBar->ShowPane(true, false, true);
pParentBar->Slide(true);

Arvshierarki

CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

Krav

rubrik:afxDockablePane.h

CDockablePane::AttachToTabWnd

Kopplar den aktuella rutan till ett målfönster och skapar ett fönster med flikar.

virtual CDockablePane* AttachToTabWnd(
    CDockablePane* pTabControlBarAttachTo,
    AFX_DOCK_METHOD dockMethod,
    BOOL bSetActive= TRUE,
    CDockablePane** ppTabbedControlBar = NULL);

Parametrar

pTabControlBarAttachTo
[in, ut] Anger målfönstret som det aktuella fönstret kopplas till. Målfönstret måste vara ett dockbart fönster.

dockMethod
[i] Anger dockningsmetoden.

bSetActive
[in] TRUE för att aktivera fönstret med flikar efter kopplingsåtgärden. annars FALSE.

ppTabbedControlBar
[ut] Innehåller det flikade fönstret som är resultatet av bifoga-åtgärden.

Returvärde

En pekare till det aktuella fönstret, om det inte är ett fönster med flikar. annars en pekare till det flikar som är resultatet av anslutningsåtgärden. Returvärdet är NULL om det aktuella fönstret inte kan kopplas eller om ett fel inträffar.

Anmärkningar

När ett dockbart fönster ansluts till ett annat fönster med den här metoden inträffar följande:

  1. Ramverket kontrollerar om målfönstret pTabControlBarAttachTo är ett vanligt dockningsfönster eller om det härleds från CBaseTabbedPane.

  2. Om målfönstret är ett fönster med flikar lägger ramverket till den aktuella rutan som en flik.

  3. Om målfönstret är ett vanligt dockningsfönster skapar ramverket ett fönster med flikar.

    • Ramverket anropar pTabControlBarAttachTo->CreateTabbedPane. Formatet för det nya fönstret med flikar beror på m_pTabbedControlBarRTC medlem. Som standard är den här medlemmen inställd på körningsklassen för CTabbedPane. Om du skickar AFX_CBRS_OUTLOOK_TABS-formatmallen som dwTabbedStyle-parametern till metoden CDockablePane::Create, är körningsklassobjektet inställt på körningsklassen för CMFCOutlookBar. Du kan ändra den här medlemmen när som helst för att ändra formatet för det nya fönstret.

    • När den här metoden skapar ett fönster med flikar ersätter ramverket pekaren mot pTabControlBarAttachTo (om fönstret är dockat eller flytande i ett fönster med flera miniramar) med en pekare till det nya fönstret med flikar.

    • Ramverket lägger till fönstret pTabControlBarAttachTo i fönstret med flikar som den första fliken. Ramverket lägger sedan till det aktuella fönstret som en andra flik.

  4. Om det aktuella fönstret härleds från CBaseTabbedPaneflyttas alla dess flikar till pTabControlBarAttachTo och det aktuella fönstret förstörs. Var därför försiktig när du anropar den här metoden eftersom en pekare till det aktuella fönstret kan vara ogiltig när metoden returneras.

Om du kopplar en ruta till en annan när du skapar en dockningslayout anger du dockMethod till DM_SHOW.

Du bör docka det första fönstret innan du kopplar en annan ruta till den.

CDockablePane::CalcFixedLayout

Returnerar storleken på rutans rektangel.

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Parametrar

bStretch
[i] Används inte.

bHorz
[i] Används inte.

Returvärde

Ett CSize objekt som innehåller storleken på rutans rektangel.

CDockablePane::CanAcceptMiniFrame

Avgör om den angivna miniramen kan dockas till fönstret.

virtual BOOL CanAcceptMiniFrame(CPaneFrameWnd* pMiniFrame) const;

Parametrar

pMiniFrame
[i] Pekare till ett CPaneFrameWnd objekt.

Returvärde

TRUE om pMiniFrame kan dockas till fönstret. annars FALSE.

CDockablePane::CanAcceptPane

Avgör om ett annat fönster kan dockas till det aktuella fönstret.

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parametrar

pBar
[i] Anger fönstret som ska dockas till det aktuella fönstret.

Returvärde

TRUE om det angivna fönstret kan dockas till det här fönstret. annars FALSE.

Anmärkningar

Ramverket anropar den här metoden innan ett fönster dockas till det aktuella fönstret.

Åsidosätt den här funktionen i en härledd klass för att aktivera eller inaktivera dockning till ett visst fönster.

Som standard returnerar den här metoden TRUE om antingen pBar eller dess överordnade är av typen CDockablePane.

CDockablePane::CanAutoHide

Avgör om fönstret kan döljas automatiskt.

virtual BOOL CanAutoHide() const;

Returvärde

TRUE om fönstret kan döljas automatiskt. annars FALSE.

Anmärkningar

CDockablePane::CanAutoHide returnerar FALSE i någon av följande situationer:

  • Fönstret har ingen överordnad.

  • Dockningshanteraren tillåter inte att fönsterrutor döljs automatiskt.

  • Fönstret är inte dockat.

CDockablePane::CanBeAttached

Avgör om det aktuella fönstret kan dockas till ett annat fönster.

virtual BOOL CanBeAttached() const;

Returvärde

TRUE om det dockbara fönstret kan dockas till ett annat fönster eller till huvudramfönstret. annars FALSE.

Anmärkningar

Som standard returnerar den här metoden alltid TRUE. Åsidosätt den här metoden i en härledd klass för att aktivera eller inaktivera dockning utan att anropa CBasePane::EnableDocking.

CDockablePane::CDockablePane

Konstruerar och initierar ett CDockablePane objekt.

CDockablePane();

Anmärkningar

När du har skapat ett dockbart fönsterobjekt anropar du CDockablePane::Create eller CDockablePane::CreateEx för att skapa det.

CDockablePane::ConvertToTabbedDocument

Konverterar ett eller flera dockbara fönster till MDI-flikar.

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

Parametrar

bActiveTabOnly
[i] När du konverterar en CTabbedPaneanger du TRUE att endast konvertera den aktiva fliken. Ange FALSE om du vill konvertera alla flikar i fönstret.

CDockablePane::CheckAutoHideCondition

Avgör om dockningsfönstret är dolt (även kallat autohide-läge).

virtual BOOL CheckAutoHideCondition();

Returvärde

TRUE om hide-villkoret är uppfyllt. annars FALSE.

Anmärkningar

Ramverket använder en timer för att regelbundet kontrollera om ett automatiskt dockbart fönster ska döljas. Metoden returnerar TRUE när fönstret inte är aktivt, fönstret ändras inte och muspekaren är inte över fönstret.

Om alla tidigare villkor uppfylls anropar ramverket CDockablePane::Slide för att dölja fönstret.

CDockablePane::CheckStopSlideCondition

Avgör när ett autohide-dockningsfönster ska sluta glida.

virtual BOOL CheckStopSlideCondition(BOOL bDirection);

Parametrar

bDirection
[in] TRUE om fönstret är synligt; FALSE om fönstret är dolt.

Returvärde

TRUE om stoppvillkoret är uppfyllt. annars FALSE.

Anmärkningar

När ett dockbart fönster är inställt på autohide-läge använder ramverket skjuteffekter för att visa eller dölja fönstret. Ramverket anropar den här funktionen när fönstret skjuts. CheckStopSlideCondition returnerar TRUE när fönstret är helt synligt eller när det är helt dolt.

Åsidosätt den här metoden i en härledd klass för att implementera anpassade autohide-effekter.

CDockablePane::CopyState

Kopierar tillståndet för ett dockbart fönster.

virtual void CopyState(CDockablePane* pOrgBar);

Parametrar

pOrgBar
[i] En pekare till ett dockningsbart fönster.

Anmärkningar

CDockablePane::CopyState kopierar tillståndet för pOrgBar till det aktuella fönstret genom att anropa följande metoder:

CDockablePane::Create

Skapar Windows-kontrollen och kopplar den till objektet CDockablePane.

virtual BOOL Create(
    LPCTSTR lpszCaption,
    CWnd* pParentWnd,
    const RECT& rect,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE,
    CCreateContext* pContext = NULL);

virtual BOOL Create(
    LPCTSTR lpszWindowName,
    CWnd* pParentWnd,
    CSize sizeDefault,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle = WS_CHILD|WS_VISIBLE|CBRS_TOP|CBRS_HIDE_INPLACE,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE);

Parametrar

lpszCaption
[i] Anger fönsternamnet.

pParentWnd
[in, ut] Anger det överordnade fönstret.

rect
[i] Anger fönstrets storlek och position i klientkoordinater för pParentWnd.

bHasGripper
[i] TRUE för att skapa fönstret med en bildtext; annars FALSE.

nID
[i] Anger ID för det underordnade fönstret. Det här värdet måste vara unikt om du vill spara dockningstillståndet för det här dockningsfönstret.

dwStyle
[i] Anger attribut för fönsterformat.

dwTabbedStyle
[i] Anger stilen med flikar i ett fönster med flikar som skapas när användaren drar ett fönster i beskrivningen av det här fönstret.

dwControlBarStyle
[i] Anger ytterligare formatattribut.

pContext
[in, ut] Anger fönstrets skapa-kontext.

lpszWindowName
[i] Anger fönsternamnet.

sizeDefault
[i] Anger fönstrets storlek.

Returvärde

TRUE om det dockbara fönstret har skapats. annars FALSE.

Anmärkningar

Skapar ett Windows-fönster och kopplar det till objektet CDockablePane.

Om dwStyle-fönsterformatet har flaggan CBRS_FLOAT_MULTI kan miniframe-fönstret flyta med andra fönster i miniframe-fönstret. Som standard kan dockningsfönster endast flyta individuellt.

Om dwTabbedStyle-parametern har den AFX_CBRS_OUTLOOK_TABS flaggan angiven skapar fönstret flikar i Outlook-stil när ett annat fönster är kopplat till det här fönstret med hjälp av metoden CDockablePane::AttachToTabWnd. Som standard skapar dockbara fönsterrutor vanliga flikar av typen CTabbedPane.

CDockablePane::CreateDefaultPaneDivider

Skapar en standardavdelare för fönstret när den dockas till ett ramfönster.

static CPaneDivider* __stdcall CreateDefaultPaneDivider(
    DWORD dwAlignment,
    CWnd* pParent,
    CRuntimeClass* pSliderRTC = NULL);

Parametrar

dwAlignment
[i] Anger den sida av huvudramen som fönstret dockas till. Om dwAlignment innehåller flaggan CBRS_ALIGN_LEFT eller CBRS_ALIGN_RIGHT skapar den här metoden en lodrät (CPaneDivider::SS_VERT) avdelare. annars skapar den här metoden en vågrät (CPaneDivider::SS_HORZ) avdelare.

pParent
[i] Pekare till den överordnade ramen.

pSliderRTC
[i] Används inte.

Returvärde

Den här metoden returnerar en pekare till den nyligen skapade avdelaren, eller NULL om det inte går att skapa avdelaren.

Anmärkningar

dwAlignment kan vara något av följande värden:

Värde Beskrivning
CBRS_ALIGN_TOP Fönstret dockas överst i klientområdet i ett ramfönster.
CBRS_ALIGN_BOTTOM Fönstret dockas längst ned i klientområdet i ett ramfönster.
CBRS_ALIGN_LEFT Fönstret dockas till vänster i klientområdet i ett ramfönster.
CBRS_ALIGN_RIGHT Fönstret dockas till höger om klientområdet i ett ramfönster.

CDockablePane::CreateEx

Skapar Windows-kontrollen och kopplar den till objektet CDockablePane.

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszCaption,
    CWnd* pParentWnd,
    const RECT& rect,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE,
    CCreateContext* pContext = NULL);

Parametrar

dwStyleEx
[i] Anger de utökade formatattributen för det nya fönstret.

lpszCaption
[i] Anger fönsternamnet.

pParentWnd
[in, ut] Anger det överordnade fönstret.

rect
[i] Anger fönstrets storlek och position i klientkoordinater för pParentWnd.

bHasGripper
[i] TRUE för att skapa fönstret med en bildtext; annars FALSE.

nID
[i] Anger ID för det underordnade fönstret. Det här värdet måste vara unikt om du vill spara dockningstillståndet för det här dockningsfönstret.

dwStyle
[i] Anger attribut för fönsterformat.

dwTabbedStyle
[i] Anger stilen med flikar i ett fönster med flikar som skapas när användaren drar ett fönster i beskrivningen av det här fönstret.

dwControlBarStyle
[i] Anger de ytterligare formatattributen.

pContext
[in, ut] Anger fönstrets skapa-kontext.

Returvärde

TRUE om det dockbara fönstret har skapats. annars FALSE.

Anmärkningar

Skapar ett Windows-fönster och kopplar det till objektet CDockablePane.

Om dwStyle-fönsterformatet har flaggan CBRS_FLOAT_MULTI kan miniframe-fönstret flyta med andra fönster i miniframe-fönstret. Som standard kan dockningsfönster endast flyta individuellt.

Om dwTabbedStyle-parametern har den AFX_CBRS_OUTLOOK_TABS flaggan angiven skapar fönstret flikar i Outlook-stil när ett annat fönster är kopplat till det här fönstret med hjälp av metoden CDockablePane::AttachToTabWnd. Som standard skapar dockbara fönsterrutor vanliga flikar av typen CTabbedPane.

CDockablePane::CreateTabbedPane

Skapar ett fönster med flikar från det aktuella fönstret.

virtual CTabbedPane* CreateTabbedPane();

Returvärde

Det nya fönstret med flikar eller NULL om skapandeåtgärden misslyckades.

Anmärkningar

Ramverket anropar den här metoden när den skapar ett fönster med flikar för att ersätta det här fönstret. Mer information finns i CDockablePane::AttachToTabWnd.

Åsidosätt den här metoden i en härledd klass för att anpassa hur flikar skapas och initieras.

Fönstret med flikar skapas enligt den runtime-klassinformation som lagras i den m_pTabbedControlBarRTC medlemmen, som initieras av metoden CDockablePane::CreateEx.

CDockablePane::DockPaneContainer

Dockar en container till fönstret.

virtual BOOL DockPaneContainer(
    CPaneContainerManager& barContainerManager,
    DWORD dwAlignment,
    AFX_DOCK_METHOD dockMethod);

Parametrar

barContainerManager
[i] En referens till containerhanteraren för den container som dockas.

dwAlignment
[in] DWORD som anger den sida av fönstret som containern dockas till.

dockMethod
[i] Används inte.

Returvärde

TRUE om containern har dockats till fönstret. annars FALSE.

Anmärkningar

dwAlignment kan vara något av följande värden:

Värde Beskrivning
CBRS_ALIGN_TOP Containern dockas överst i fönstret.
CBRS_ALIGN_BOTTOM Containern dockas längst ned i fönstret.
CBRS_ALIGN_LEFT Containern dockas till vänster i fönstret.
CBRS_ALIGN_RIGHT Containern dockas till höger om fönstret.

CDockablePane::DockPaneStandard

Dockar ett fönster med hjälp av dispositions-dockning (standard).

virtual CPane* DockPaneStandard(BOOL& bWasDocked);

Parametrar

bWasDocked
[i] När metoden returnerar innehåller det här värdet TRUE om fönstret har dockats. annars innehåller den FALSE.

Returvärde

Om fönstret dockades till ett fönster med flikar, eller om ett fönster med flikar skapades till följd av dockning, returnerar den här metoden en pekare till fönstret med flikar. Om fönstret annars har dockats returnerar den här metoden this pekaren. Om dockningen misslyckades returnerar den här metoden NULL.

CDockablePane::DockToRecentPos

Dockar ett fönster till dess lagrade dockningsposition.

BOOL CDockablePane::DockToRecentPos();

Returvärde

TRUE om fönstret är dockat. annars FALSE.

Anmärkningar

Dockningsbara fönster lagrar den senaste dockningsinformationen i ett CRecentDockSiteInfo objekt.

CDockablePane::DockToWindow

Dockar ett dockningsfönster till ett annat dockningsfönster.

virtual BOOL DockToWindow(
    CDockablePane* pTargetWindow,
    DWORD dwAlignment,
    LPCRECT lpRect = NULL);

Parametrar

pTargetWindow
[in, ut] Anger det dockningsbara fönstret som det här fönstret ska dockas till.

dwAlignment
[i] Anger dockningsjusteringen för fönstret. Kan vara en av CBRS_ALIGN_LEFT, CBRS_ALIGN_TOP, CBRS_ALIGN_RIGHT, CBRS_ALIGN_BOTTOM eller CBRS_ALIGN_ANY. (Definieras i afxres.h.)

lpRect
[i] Anger dockningsrektangeln för fönstret.

Returvärde

TRUE om fönstret har dockats. annars FALSE.

Anmärkningar

Anropa den här metoden för att docka ett fönster till ett annat fönster med den justering som anges av dwAlignment.

CDockablePane::DrawCaption

Ritar bildtexten (kallas även griparen) i ett dockningsfönster.

virtual void DrawCaption(
    CDC* pDC,
    CRect rectCaption);

Parametrar

pDC
[i] Representerar enhetskontexten som används för ritning.

rectCaption
[i] Anger avgränsningsrektangeln för fönstrets bildtext.

Anmärkningar

Ramverket anropar den här metoden för att rita beskrivningen av ett dockbart fönster.

Åsidosätt den här metoden i en härledd klass för att anpassa beskrivningens utseende.

CDockablePane::EnableAutohideAll

Aktiverar eller inaktiverar autohide-läge för det här fönstret och för andra fönster i containern.

void EnableAutohideAll(BOOL bEnable = TRUE);

Parametrar

bEnable
[in] TRUE för att aktivera funktionen för att automatiskt visa alla för det dockbara fönstret. annars FALSE.

Anmärkningar

När en användare har Ctrl-tangenten och klickar på fästknappen för att växla ett fönster till autohide-läge, växlas även alla andra fönster i samma container till autohide-läge.

Anropa den här metoden med bEnable inställd på FALSE för att inaktivera den här funktionen för ett visst fönster.

CDockablePane::EnableGripper

Visar eller döljer bildtexten (kallas även griparen).

virtual void EnableGripper(BOOL bEnable);

Parametrar

bEnable
[in] TRUE för att aktivera bildtexten; annars FALSE.

Anmärkningar

När ramverket skapar dockningsbara fönster har de inte WS_STYLE fönsterformat, även om det har angetts. Det innebär att fönstrets beskrivning är ett icke-klientområde som styrs av ramverket, men det här området skiljer sig från standardfönstrets beskrivning.

Du kan visa eller dölja bildtexten när som helst. Ramverket döljer bildtexten när ett fönster läggs till som en flik i ett fönster med flikar eller när ett fönster flyttas i ett miniframe-fönster.

CDockablePane::GetAHRestoredRect

Anger fönstrets position när den är i läget dölj automatiskt.

CRect GetAHRestoredRect() const;

Returvärde

Ett CRect objekt som innehåller fönstrets position när det är i läget dölj automatiskt.

Anmärkningar

CDockablePane::GetAHSlideMode

Hämtar det automatiska dölj bildläget för fönstret.

virtual UINT GetAHSlideMode() const;

Returvärde

En UINT som anger automatiskt dölj bildläge för fönstret. Returvärdet kan vara antingen AFX_AHSM_MOVE eller AFX_AHSM_STRETCH, men implementeringen använder bara AFX_AHSM_MOVE.

Anmärkningar

CDockablePane::GetCaptionHeight

Returnerar höjden i bildpunkter för den aktuella bildtexten.

virtual int GetCaptionHeight() const;

Returvärde

Bildtextens höjd i bildpunkter.

Anmärkningar

Bildtextens höjd är 0 om bildtexten var dold av metoden CDockablePane::EnableGripper, eller om fönstret inte har någon bildtext.

CDockablePane::GetDefaultPaneDivider

Returnerar standardfönstrets avdelare för fönstrets container.

CPaneDivider* GetDefaultPaneDivider() const;

Returvärde

Ett giltigt CPaneDivider objekt om det dockbara fönstret dockas till huvudramsfönstret, eller NULL om det dockbara fönstret inte är dockat eller om det är flytande.

Anmärkningar

Mer information om fönsteravdelare finns i CPaneDivider Class.

CDockablePane::GetDockingStatus

Avgör möjligheten för ett fönster att dockas baserat på den angivna pekarplatsen.

virtual AFX_CS_STATUS GetDockingStatus(
    CPoint pt,
    int nSensitivity);

Parametrar

pt
[i] Pekarens plats i skärmkoordinater.

nSensitivity
[i] Avståndet, i bildpunkter, bort från kanten av en rektangel som pekaren måste vara för att aktivera dockning.

Returvärde

Ett av följande statusvärden:

AFX_CS_STATUS värde Betydelse
CS_NOTHING Pekaren är inte över en dockningsplats. Ramverket dockar inte fönstret.
CS_DOCK_IMMEDIATELY Pekaren finns över dockningsplatsen i omedelbart läge (fönstret använder DT_IMMEDIATE dockningsläge). Ramverket dockar fönstret omedelbart.
CS_DELAY_DOCK Pekaren är över en dockningsplats som är ett annat dockningsfönster eller är en kant av huvudramen. Ramverket dockar fönstret efter en fördröjning. Mer information om den här fördröjningen finns i avsnittet Kommentarer.
CS_DELAY_DOCK_TO_TAB Pekaren finns över en dockningsplats som gör att fönstret dockas i ett fönster med flikar. Detta inträffar när pekaren finns över bildtexten i ett annat dockningsfönster eller över flikområdet i ett fönster med flikar.

Anmärkningar

Ramverket anropar den här metoden för att hantera dockning av ett flytande fönster.

För flytande verktygsfält eller dockningsfönster som använder DT_IMMEDIATE dockningsläge fördröjer ramverket dockningskommandot så att användaren kan flytta fönstret ut från klientområdet i den överordnade ramen innan dockningen sker. Fördröjningens längd mäts i millisekunder och styrs av den CDockingManager::m_nTimeOutBeforeToolBarDock datamedlemmen. Standardvärdet för CDockingManager::m_nTimeOutBeforeToolBarDock är 200. Det här beteendet emulerar dockningsbeteendet för Microsoft Word 2007.

För fördröjda dockningstillstånd (CS_DELAY_DOCK och CS_DELAY_DOCK_TO_TAB) utför ramverket inte dockning förrän användaren släpper musknappen. Om ett fönster använder DT_STANDARD dockningsläge visar ramverket en rektangel på den planerade dockningsplatsen. Om ett fönster använder DT_SMART dockningsläge visar ramverket smarta dockningsmarkörer och halvtransparenta rektanglar på den planerade dockningsplatsen. Om du vill ange dockningsläget för fönstret anropar du metoden CBasePane::SetDockingMode. Mer information om smart dockning finns i CDockingManager::GetSmartDockingParams.

CDockablePane::GetDragSensitivity

Returnerar drakänsligheten för ett dockningsfönster.

static const CSize& GetDragSensitivity();

Returvärde

Ett CSize objekt som innehåller bredden och höjden i bildpunkter för en rektangel centrerad på en dragpunkt. Dragåtgärden börjar inte förrän muspekaren flyttas utanför den här rektangeln.

CDockablePane::GetLastPercentInPaneContainer

Hämtar procentandelen utrymme som ett fönster upptar i containern ( CPaneContainer klass).

int GetLastPercentInPaneContainer() const;

Returvärde

En int som anger procentandelen utrymme som fönstret upptar i containern.

Anmärkningar

Den här metoden används när containern justerar sin layout.

CDockablePane::GetTabArea

Hämtar flikområdet för fönstret.

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const;

Parametrar

rectTabAreaTop
[in] GetTabArea fyller den här variabeln med flikområdet om flikarna finns överst i fönstret. Om flikarna finns längst ned i fönstret fylls den här variabeln med en tom rektangel.

rectTabAreaBottom
[in] GetTabArea fyller den här variabeln med flikområdet om flikarna finns längst ned i fönstret. Om flikarna finns överst i fönstret fylls den här variabeln med en tom rektangel.

Anmärkningar

Den här metoden används endast i klasser som härleds från CDockablePane och har flikar. Mer information finns i CTabbedPane::GetTabArea och CMFCOutlookBar::GetTabArea.

CDockablePane::GetTabbedPaneRTC

Returnerar runtime-klassinformationen om ett fönster med flikar som skapas när ett annat fönster dockar till det aktuella fönstret.

CRuntimeClass* GetTabbedPaneRTC() const;

Returvärde

Körningsklassinformationen för det dockbara fönstret.

Anmärkningar

Anropa den här metoden för att hämta körningsklassinformationen för flikar som skapas dynamiskt. Detta kan inträffa när en användare drar ett fönster till bildtexten i ett annat fönster, eller om du anropar metoden CDockablePane::AttachToTabWnd för att programmatiskt skapa ett fönster med flikar från två dockningsbara fönster.

Du kan ange körningsklassinformationen genom att anropa metoden CDockablePane::SetTabbedPaneRTC.

CDockablePane::HasAutoHideMode

Anger om ett dockningsfönster kan växlas till autohide-läge.

virtual BOOL HasAutoHideMode() const;

Returvärde

TRUE om det dockbara fönstret kan växlas till autohide-läge. annars FALSE.

Anmärkningar

Åsidosätt den här metoden i en härledd klass för att inaktivera autohide-läge för ett specifikt dockningsbart fönster.

CDockablePane::HitTest

Anger platsen i ett fönster där användaren klickar på en mus.

virtual int HitTest(
    CPoint point,
    BOOL bDetectCaption = FALSE);

Parametrar

point
[i] Anger den punkt som ska testas.

bDetectCaption
[in] TRUE om HTCAPTION ska returneras om punkten finns i fönstrets bildtext. annars FALSE.

Returvärde

Något av följande värden:

  • HTNOWHERE om point inte finns i det dockbara fönstret.

  • HTCLIENT om point finns i klientområdet i det dockbara fönstret.

  • HTCAPTION om point finns i undertextområdet i det dockbara fönstret.

  • AFX_HTCLOSE om point är på knappen Stäng.

  • HTMAXBUTTON om point finns på pin-knappen.

CDockablePane::IsAutohideAllEnabled

Anger om dockningsfönstret och alla andra fönster i containern kan växlas till autohide-läge.

virtual BOOL IsAutohideAllEnabled() const;

Returvärde

TRUE om det dockbara fönstret, och alla andra fönster i containern, kan växlas till automatiskt läge. annars FALSE.

Anmärkningar

En användare aktiverar autohide-läge genom att klicka på knappen för att lägga till pin-kod medan Ctrl--tangenten

Om du vill aktivera eller inaktivera det här beteendet anropar du metoden CDockablePane::EnableAutohideAll.

CDockablePane::IsAutoHideMode

Avgör om ett fönster är i autohide-läge.

virtual BOOL IsAutoHideMode() const;

Returvärde

TRUE om det dockbara fönstret är i autohide-läge. annars FALSE.

CDockablePane::IsDocked

Avgör om det aktuella fönstret är dockat.

virtual BOOL IsDocked() const;

Returvärde

TRUE om det dockbara fönstret inte tillhör ett miniframe-fönster eller om det svävar i ett miniramfönster med ett annat fönster. FALSE om fönstret är underordnat ett miniframe-fönster och det inte finns några andra fönster som tillhör miniframe-fönstret.

Anmärkningar

Om du vill ta reda på om fönstret är dockat till huvudramsfönstret anropar du CDockablePane::GetDefaultPaneDivider. Om metoden returnerar en pekare som inte ärNULL dockas fönstret i huvudramfönstret.

CDockablePane::IsHideInAutoHideMode

Avgör beteendet för en ruta som är i autohide-läge om den visas (eller döljs) genom att anropa CDockablePane::ShowPane.

virtual BOOL IsHideInAutoHideMode() const;

Returvärde

TRUE om det dockningsbara fönstret ska döljas när det är i autohide-läge. annars FALSE.

Anmärkningar

När ett dockbart fönster är i automatiskthideläge fungerar det annorlunda när du anropar ShowPane för att dölja eller visa fönstret. Det här beteendet styrs av den statiska medlemmen CDockablePane::m_bHideInAutoHideMode. Om den här medlemmen är TRUEdöljs det dockbara fönstret och dess relaterade autohide-verktygsfält eller autohide-knapp eller när du anropar ShowPane. Annars aktiveras eller inaktiveras det dockbara fönstret och dess relaterade autohide-verktygsfält eller autohide-knapp visas alltid.

Åsidosätt den här metoden i en härledd klass för att ändra standardbeteendet för enskilda fönster.

Standardvärdet för m_bHideInAutoHideMode är FALSE.

CDockablePane::IsInFloatingMultiPaneFrameWnd

Anger om fönstret finns i ett ramfönster med flera fönster ( CMultiPaneFrameWnd Class).

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

Returvärde

TRUE om fönstret finns i ett ramfönster med flera fönster. annars FALSE.

Anmärkningar

CDockablePane::IsResizable

Anger om fönstret kan ändras.

virtual BOOL IsResizable() const;

Returvärde

TRUE om fönstret kan ändras. annars FALSE.

Anmärkningar

Som standard kan dockningsbara fönster ändras. Om du vill förhindra storleksändring åsidosätter du den här metoden i en härledd klass och returnerar FALSE. Observera att ett FALSE värde leder till en misslyckad ASSERT i CPane::DockPane. Använd CDockingManager::AddPane i stället för att docka ett fönster i en överordnad ram.

Fönster som inte kan ändras kan varken flytta eller ange automatiskt döljläge och finns alltid i den överordnade ramens yttre kant.

CDockablePane::IsTabLocationBottom

Anger om flikarna finns överst eller längst ned i fönstret.

virtual BOOL IsTabLocationBottom() const;

Returvärde

TRUE om flikarna finns längst ned i fönstret. FALSE om flikarna finns överst i fönstret.

Anmärkningar

Mer information finns i CTabbedPane::IsTabLocationBottom.

CDockablePane::IsTracked

Anger om ett fönster flyttas av användaren.

BOOL IsTracked() const;

Returvärde

TRUE om fönstret flyttas. annars FALSE.

CDockablePane::IsVisible

Avgör om det aktuella fönstret är synligt.

virtual BOOL IsVisible() const;

Returvärde

TRUE om det dockbara fönstret är synligt. annars FALSE.

Anmärkningar

Anropa den här metoden för att avgöra om ett dockbart fönster visas. Du kan använda den här metoden i stället för att anropa CWnd::IsWindowVisible eller testa för WS_VISIBLE formatmall. Det returnerade synlighetstillståndet beror på om autohide-läget är aktiverat eller inaktiverat och värdet för egenskapen CDockablePane::IsHideInAutoHideMode.

Om det dockbara fönstret är i automatiskthideläge och IsHideInAutoHideMode returnerar FALSE är synlighetstillståndet alltid FALSE.

Om det dockningsbara fönstret är i automatiskthideläge och IsHideInAutoHideMode returnerar TRUE synlighetstillståndet beror på synlighetstillståndet för det relaterade verktygsfältet för automatisk hidning.

Om det dockbara fönstret inte är i automatiskthideläge bestäms synlighetstillståndet av metoden CBasePane::IsVisible.

## CDockablePane::LoadState

Endast för internt bruk. Mer information finns i källkoden som finns i mappen mfc i Visual Studio-installationen. Till exempel %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

virtual BOOL LoadState(
   LPCTSTR lpszProfileName = NULL,
   int nIndex = -1,
   UINT uiID = (UINT) -1
);

CDockablePane::m_bDisableAnimation

Anger om autohide-animering av det dockbara fönstret är inaktiverat.

AFX_IMPORT_DATA static BOOL m_bDisableAnimation;

CDockablePane::m_bHideInAutoHideMode

Avgör hur fönstret fungerar när fönstret är i automatiskt läge.

AFX_IMPORT_DATA static BOOL m_bHideInAutoHideMode;

Anmärkningar

Det här värdet påverkar alla dockningsfönster i programmet.

Om du ställer in den här medlemmen på TRUEdöljs dockbara fönster eller visas med deras relaterade verktygsfält och knappar när du anropar CDockablePane::ShowPane.

Om du ställer in den här medlemmen på FALSEaktiveras eller inaktiveras dockbara fönster när du anropar CDockablePane::ShowPane.

CDockablePane::m_nSlideSteps

Anger animeringshastigheten för fönstret när det är i autohide-läge.

AFX_IMPORT_DATA static int m_nSlideSteps;

Anmärkningar

Minska det här värdet för en snabbare animeringseffekt. Öka det här värdet för en långsammare animeringseffekt.

CDockablePane::OnAfterChangeParent

Mer information finns i källkoden som finns i mappen mfc i Visual Studio-installationen. Till exempel %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

Parametrar

[i] pWndOldParent\

Anmärkningar

CDockablePane::OnAfterDockFromMiniFrame

Anropas av ramverket när ett flytande dockningsfält dockar i ett ramfönster.

virtual void OnAfterDockFromMiniFrame();

Anmärkningar

Som standard gör den här metoden ingenting.

CDockablePane::OnBeforeChangeParent

Ramverket anropar den här metoden innan den ändrar överordnad i fönstret.

virtual void OnBeforeChangeParent(
    CWnd* pWndNewParent,
    BOOL bDelay = FALSE);

Parametrar

pWndNewParent
[i] En pekare till det nya överordnade fönstret.

bDelay
[i] BOOL som anger om omberäkning av dockningslayouten ska fördröjas om fönstret är avdockat. Mer information finns i CDockablePane::UndockPane.

Anmärkningar

Om fönstret är dockat och det nya överordnade objektet inte tillåter dockning, tar den här metoden bort fönstret.

Om fönstret konverteras till ett tabbdokument lagrar den här metoden sin senaste dockningsposition. Ramverket använder den senaste dockningspositionen för att återställa positionen för fönstret när den konverteras tillbaka till ett dockat tillstånd.

CDockablePane::OnBeforeFloat

Ramverket anropar den här metoden innan ett fönster övergår till ett flytande tillstånd.

virtual BOOL OnBeforeFloat(
    CRect& rectFloat,
    AFX_DOCK_METHOD dockMethod);

Parametrar

rectFloat
[i] Anger fönstrets position och storlek när det är i flytande tillstånd.

dockMethod
[i] Anger dockningsmetoden. En lista över möjliga värden finns i CPane::DockPane.

Returvärde

TRUE om fönstret kan flyta; annars FALSE.

Anmärkningar

Den här metoden anropas av ramverket när ett fönster håller på att flyta. Du kan åsidosätta den här metoden i en härledd klass om du vill utföra någon bearbetning innan fönstret flyter.

CDockablePane::OnPressButtons

Anropas när användaren trycker på en annan bildtextknapp än knapparna AFX_HTCLOSE och AFX_HTMAXBUTTON.

virtual void OnPressButtons(UINT nHit);

Parametrar

nHit
[i] Den här parametern används inte.

Anmärkningar

Om du lägger till en anpassad knapp i beskrivningen av ett dockningsbart fönster åsidosätter du den här metoden för att ta emot meddelanden när en användare trycker på knappen.

CDockablePane::OnSlide

Anropas av ramverket för att animera fönstret när det är i autohide-läge.

virtual void OnSlide(BOOL bSlideOut);

Parametrar

bSlideOut
[i] TRUE för att visa fönstret; FALSE för att dölja fönstret.

Anmärkningar

Åsidosätt den här metoden i en härledd klass för att implementera anpassade autohide-effekter.

CDockablePane::RemoveFromDefaultPaneDividier

Ramverket anropar den här metoden när en ruta kopplas från.

void RemoveFromDefaultPaneDividier();

Anmärkningar

Den här metoden anger standardfönstrets avdelare till NULL och tar bort fönstret från containern.

CDockablePane::ReplacePane

Ersätter fönstret med ett angivet fönster.

BOOL ReplacePane(
    CDockablePane* pBarToReplaceWith,
    AFX_DOCK_METHOD dockMethod,
    BOOL bRegisterWithFrame = FALSE);

Parametrar

pBarToReplaceWith
[i] En pekare till ett dockningsbart fönster.

dockMethod
[i] Används inte.

bRegisterWithFrame
[i] Om TRUEregistreras det nya fönstret med dockningshanteraren för det överordnade fönstret. Den nya rutan infogas i indexet för det gamla fönstret i listan över fönster som underhålls av dockningshanteraren.

Returvärde

TRUE om ersättningen lyckas. annars FALSE.

CDockablePane::RestoreDefaultPaneDivider

När ett fönster deserialiseras anropar ramverket den här metoden för att återställa standardfönstrets avdelare.

void RestoreDefaultPaneDivider();

Anmärkningar

Den återställde standardfönsteravdelaren ersätter den aktuella standardfönsteravdelaren om den finns.

CDockablePane::SetAutoHideMode

Växlar dockningsfönstret mellan synligt läge och autohide-läge.

virtual CMFCAutoHideBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

Parametrar

bMode
[in] TRUE för att aktivera autohide-läge; FALSE för att aktivera vanligt dockningsläge.

dwAlignment
[i] Anger justeringen av fönstret för att skapa automatiskt.

pCurrAutoHideBar
[in, ut] En pekare till det aktuella autohide-verktygsfältet. Kan NULL.

bUseTimer
[i] Anger om autohide-effekten ska användas när användaren växlar fönstret till autohide-läge eller om fönstret ska döljas omedelbart.

Returvärde

Autohide-verktygsfältet som skapades som ett resultat av att växla till autohide-läge eller NULL.

Anmärkningar

Ramverket anropar den här metoden när en användare klickar på pin-knappen för att växla det dockbara fönstret till automatiskt läge eller till vanligt dockningsläge.

Anropa den här metoden för att växla ett dockbart fönster till automatiskt läge programmatiskt. Fönstret måste dockas till huvudramsfönstret ( CDockablePane::GetDefaultPaneDivider måste returnera en giltig pekare till CPaneDivider).

CDockablePane::SetAutoHideParents

Anger knappen dölj automatiskt och verktygsfältet dölj automatiskt för fönstret.

void SetAutoHideParents(
    CMFCAutoHideBar* pToolBar,
    CMFCAutoHideButton* pBtn);

Parametrar

pToolBar
[i] Pekare till ett verktygsfält som döljs automatiskt.

pBtn
[i] Pekare till en knapp för att dölja automatiskt.

CDockablePane::SetLastPercentInPaneContainer

Anger procentandelen utrymme som ett fönster upptar i containern.

void SetLastPercentInPaneContainer(int n);

Parametrar

n
[i] En int som anger procentandelen utrymme som fönstret upptar i containern.

Anmärkningar

Ramverket justerar fönstret så att det nya värdet används när layouten beräknas om.

CDockablePane::SetRestoredDefaultPaneDivider

Anger den återställde standardfönstrets avdelare.

void SetRestoredDefaultPaneDivider(HWND hRestoredSlider);

Parametrar

hRestoredSlider
[i] Ett handtag till ett fönsteravdelare (skjutreglage).

Anmärkningar

En återställd standardfönsteravdelare hämtas när en ruta deserialiseras. Mer information finns i CDockablePane::RestoreDefaultPaneDivider.

CDockablePane::SetTabbedPaneRTC

Anger körningsklassinformationen för ett fönster med flikar som skapas när två fönster dockar tillsammans.

void SetTabbedPaneRTC(CRuntimeClass* pRTC);

Parametrar

pRTC
[i] Körningsklassinformationen för fönstret med flikar.

Anmärkningar

Anropa den här metoden för att ange körningsklassinformation för flikar som skapas dynamiskt. Detta kan inträffa när en användare drar ett fönster till bildtexten i ett annat fönster, eller om du anropar metoden CDockablePane::AttachToTabWnd för att programmatiskt skapa ett fönster med flikar från två dockningsbara fönster.

Standardkörningsklassen anges enligt parametern dwTabbedStyle för CDockablePane::Create och CDockablePane::CreateEx. Om du vill anpassa de nya flikarna härleder du klassen från någon av följande klasser:

Anropa sedan den här metoden med pekaren till dess körningsklassinformation.

CDockablePane::ShowPane

Visar eller döljer ett fönster.

virtual void ShowPane(
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parametrar

bShow
[i] TRUE för att visa fönstret; FALSE för att dölja fönstret.

bDelay
[i] TRUE för att fördröja justeringen av dockningslayouten. FALSE för att justera dockningslayouten omedelbart.

bActivate
[in] TRUE för att aktivera fönstret när det visas; annars FALSE.

Anmärkningar

Anropa den här metoden i stället för CWnd::ShowWindow när du visar eller döljer dockningsbara fönster.

CDockablePane::Slide

Animerar ett fönster som är i autohide-läge.

virtual void Slide(
    BOOL bSlideOut,
    BOOL bUseTimer = TRUE);

Parametrar

bSlideOut
[i] TRUE för att visa fönstret; FALSE för att dölja fönstret.

bUseTimer
[i] TRUE för att visa eller dölja fönstret med autohide-effekten. FALSE för att visa eller dölja fönstret omedelbart.

Anmärkningar

Ramverket anropar den här metoden för att animera ett fönster som är i autohide-läge.

Den här metoden använder värdet CDockablePane::m_nSlideDefaultTimeOut för att fastställa tidsgränsen för bildeffekten. Standardvärdet för tidsgränsen är 1. Om du anpassar autohide-algoritmen ändrar du den här medlemmen för att ändra tidsgränsen.

CDockablePane::ToggleAutoHide

Växlar fönstret mellan läget alltid synligt och dölj automatiskt.

virtual void ToggleAutoHide();

Anmärkningar

Den här metoden växlar automatiskt döljläge för fönstret genom att anropa CDockablePane::SetAutoHideMode.

CDockablePane::UndockPane

Kopplar bort en ruta från antingen huvudramsfönstret eller en miniframe-fönstercontainer.

virtual void UndockPane(BOOL bDelay = FALSE);

Parametrar

bDelay
[in] TRUE för att fördröja beräkningen av dockningslayouten. FALSE för att beräkna om dockningslayouten omedelbart.

Anmärkningar

Anropa den här metoden för att koppla bort ett fönster från huvudramsfönstret eller från en fönstercontainer med flera miniramar (ett fönster som svävar i ett enda miniframe-fönster med andra fönster).

Du måste avdocka ett fönster innan du utför någon extern åtgärd som inte utförs av CDockingManager. Du måste till exempel koppla från ett fönster för att flytta det programmatiskt från en plats till en annan.

Ramverket avdockar automatiskt fönsterrutor innan de förstörs.

Se även

hierarkidiagram
klasser
CPane klass