CDockState クラス

  • [アーティクル]

いくつかのドッキング コントロール バーの状態を 2 次メモリ (ファイル) で読み込み、アンロード、またはクリアするシリアル化された CObject クラスです。

構文

class CDockState : public CObject

メンバー

パブリック メソッド

名前 説明
CDockState::Clear ドッキング状態情報をクリアします。
CDockState::GetVersion 格納されているバーの状態のバージョン番号を取得します。
CDockState::LoadState レジストリまたは .INI ファイル。
CDockState::SaveState レジストリまたは INI ファイルに状態情報を保存します。

パブリック データ メンバー

名前 説明
CDockState::m_arrBarInfo コントロール バーごとに 1 つのエントリを含む、格納されているドッキング状態情報へのポインターの配列。

解説

ドッキング状態には、バーのサイズと位置、およびバーがドッキングされているかどうかが含まれます。 保存されているドッキング状態を取得する場合、 CDockState はバーの位置を確認し、バーが現在の画面設定で表示されていない場合は、バーの位置が表示されるように CDockState スケーリングします。 CDockStateの主な目的は、多数のコントロール バーの状態全体を保持し、その状態を保存してレジストリに読み込みできるようにすることです。INI ファイル、またはCArchive オブジェクトのコンテンツの一部としてのバイナリ形式。

バーには、ツールバー、ステータス バー、ダイアログ バーなど、ドッキング可能なコントロール バーを指定できます。 CDockState オブジェクトは、 CArchive オブジェクトを介してファイルとの間で書き込まれ、読み取られます。

CFrameWnd::GetDockState は、フレーム ウィンドウのすべての CControlBar オブジェクトの状態情報を取得し、 CDockState オブジェクトに格納します。 その後、 CDockState オブジェクトの内容を Serialize または CDockState::SaveState を使用してストレージに書き込むことができます。 後でフレーム ウィンドウ内のコントロール バーの状態を復元する場合は、 Serialize または CDockState::LoadState を使用して状態を読み込み、 CFrameWnd::SetDockState を使用して、保存された状態をフレーム ウィンドウのコントロール バーに適用できます。

コントロール バーのドッキングの詳細については、「コントロール バー、ツール バー: ドッキングとフローティング、および Frame Windows に関する記事を参照してください。

継承階層

CObject

CDockState

要件

Header: afxadv.h

CDockState::Clear

この関数を呼び出して、 CDockState オブジェクトに格納されているすべてのドッキング情報をクリアします。

void Clear();

解説

これには、バーがドッキングされているかどうかだけでなく、バーのサイズと位置、表示されているかどうかも含まれます。

CDockState::GetVersion

この関数を呼び出して、格納されているバーの状態のバージョン番号を取得します。

DWORD GetVersion();

戻り値

格納されているバー情報が現在のバーの状態より古い場合は 1。格納されているバー情報が現在のバーの状態と同じ場合は 2。

解説

バージョンのサポートにより、変更されたバーは新しい永続的なプロパティを追加でき、以前のバージョンのバーによって作成された永続的な状態を検出して読み込むことができます。

CDockState::LoadState

レジストリまたはから状態情報を取得するには、この関数を呼び出します。INI ファイル。

void LoadState(LPCTSTR lpszProfileName);

パラメーター

lpszProfileName
初期化ファイル内のセクションの名前を指定する null で終わる文字列、または状態情報が格納されている Windows レジストリのキーを指します。

解説

プロファイル名は、アプリケーションのセクションです。バーの状態情報を含む INI ファイルまたはレジストリ。 コントロール バーの状態情報をレジストリまたは . SaveStateを含む INI ファイル。

CDockState::m_arrBarInfo

CDockState オブジェクトに状態情報を保存した各コントロール バーの格納されているコントロール バー情報へのポインターの配列であるCPtrArray オブジェクト。

CPtrArray m_arrBarInfo;

CDockState::SaveState

状態情報をレジストリに保存するには、この関数を呼び出します。INI ファイル。

void SaveState(LPCTSTR lpszProfileName);

パラメーター

lpszProfileName
初期化ファイル内のセクションの名前、または状態情報が格納されている Windows レジストリのキーを指定する null 型の文字列を指します。

解説

プロファイル名は、アプリケーションのセクションです。コントロール バーの状態情報を含む INI ファイルまたはレジストリ。 SaveState また、現在の画面サイズも保存されます。 コントロール バーの情報は、レジストリまたは . LoadStateを含む INI ファイル。

関連項目

CObject クラス
階層図