CDockState-Klasse

Eine serialisierte CObject -Klasse, die den Zustand einer oder mehrerer andockbarer Steuerleisten in einem persistenten Speicher (eine Datei) lädt, entlädt oder löscht.

Syntax

class CDockState : public CObject

Member

Öffentliche Methoden

Name	Beschreibung
CDockState::Clear	Löscht die Dockstatusinformationen.
CDockState::GetVersion	Ruft die Versionsnummer des gespeicherten Balkenzustands ab.
CDockState::LoadState	Ruft Statusinformationen aus der Registrierung oder . INI-Datei.
CDockState::SaveState	Speichert Statusinformationen in der Registrierung oder INI-Datei.

Öffentliche Datenmember

Name	Beschreibung
CDockState::m_arrBarInfo	Array von Zeigern auf die gespeicherten Dockzustandsinformationen mit einem Eintrag für jede Steuerleiste.

Hinweise

Der Dockzustand enthält die Größe und Position des Balkens und gibt an, ob er angedockt ist. Überprüft beim Abrufen des gespeicherten Dockzustands CDockState die Position der Leiste und skaliert, wenn die Leiste nicht mit den aktuellen Bildschirmeinstellungen angezeigt wird, die Position der Leiste so, CDockState dass sie sichtbar ist. Der Standard Zweck CDockState besteht darin, den gesamten Zustand einer Reihe von Steuerleisten zu halten und zuzulassen, dass dieser Zustand entweder in die Registrierung gespeichert und geladen werden kann, die Anwendung. INI-Datei oder in binärer Form als Teil des Inhalts eines CArchive Objekts.

Die Leiste kann eine beliebige andockbare Steuerleiste sein, einschließlich einer Symbolleiste, Statusleiste oder Dialogleiste. CDockState Objekte werden über ein CArchive Objekt in oder aus einer Datei geschrieben und gelesen.

CFrameWnd::GetDockState ruft die Statusinformationen aller Objekte des Framefensters CControlBar ab und fügt sie in das CDockState Objekt ein. Anschließend können Sie den Inhalt des CDockState Objekts in den Speicher mit Serialize oder CDockState::SaveState schreiben. Wenn Sie später den Zustand der Steuerleisten im Framefenster wiederherstellen möchten, können Sie den Zustand mit oder CDockStateSerialize::LoadState laden, und dann CFrameWnd::SetDockState verwenden, um den gespeicherten Zustand auf die Steuerleisten des Rahmenfensters anzuwenden.

Weitere Informationen zu Docking-Steuerleisten finden Sie in den Artikeln "Steuerleisten", "Symbolleisten: Andocken und Unverankert" und "Framefenster".

Vererbungshierarchie

CObject

CDockState

Anforderungen

Kopfzeile: afxadv.h

CDockState::Clear

Rufen Sie diese Funktion auf, um alle im Objekt gespeicherten CDockState Andockinformationen zu löschen.

void Clear();

Hinweise

Dies umfasst nicht nur, ob die Leiste angedockt ist, sondern auch die Größe und Position des Balkens und ob sie sichtbar ist.

CDockState::GetVersion

Rufen Sie diese Funktion auf, um die Versionsnummer des gespeicherten Balkenzustands abzurufen.

DWORD GetVersion();

Rückgabewert

1, wenn die gespeicherten Balkeninformationen älter als der aktuelle Balkenzustand sind; 2, wenn die gespeicherten Balkeninformationen mit dem aktuellen Balkenzustand identisch sind.

Hinweise

Die Versionsunterstützung ermöglicht eine überarbeitete Leiste zum Hinzufügen neuer persistenter Eigenschaften und kann den persistenten Zustand, der von einer früheren Version der Leiste erstellt wurde, weiterhin erkennen und laden.

CDockState::LoadState

Rufen Sie diese Funktion auf, um Statusinformationen aus der Registrierung oder . INI-Datei.

void LoadState(LPCTSTR lpszProfileName);

Parameter

lpszProfileName
Verweist auf eine mit Null beendete Zeichenfolge, die den Namen eines Abschnitts in der Initialisierungsdatei oder einen Schlüssel in der Windows-Registrierung angibt, in der Statusinformationen gespeichert sind.

Hinweise

Der Profilname ist der Abschnitt der Anwendung. INI-Datei oder die Registrierung, die die Statusinformationen der Balken enthält. Sie können Statusinformationen der Steuerelementleiste in der Registrierung oder in der Registrierung speichern. INI-Datei mit SaveState.

CDockState::m_arrBarInfo

Ein CPtrArray Objekt, das ein Array von Zeigern auf die gespeicherten Steuerelementleisteninformationen für jede Steuerelementleiste ist, die Statusinformationen im CDockState Objekt gespeichert hat.

CPtrArray m_arrBarInfo;

CDockState::SaveState

Rufen Sie diese Funktion auf, um die Statusinformationen in der Registrierung oder . INI-Datei.

void SaveState(LPCTSTR lpszProfileName);

Parameter

lpszProfileName
Verweist auf eine null teminierte Zeichenfolge, die den Namen eines Abschnitts in der Initialisierungsdatei oder einen Schlüssel in der Windows-Registrierung angibt, in der Statusinformationen gespeichert sind.

Hinweise

Der Profilname ist der Abschnitt der Anwendung. INI-Datei oder die Registrierung, die die Statusinformationen der Steuerelementleiste enthält. SaveState speichert auch die aktuelle Bildschirmgröße. Sie können Steuerleisteninformationen aus der Registrierung oder . INI-Datei mit LoadState.

Siehe auch

CObject-Klasse
Hierarchiediagramm