Класс CDockState

Замечание

Библиотека классов Microsoft Foundation (MFC) продолжает поддерживаться. Однако мы больше не добавляем функции или обновляем документацию.

Сериализуемый класс CObject для загрузки, выгрузки или очистки состояния одной или нескольких закрепляемых панелей элементов управления в постоянной памяти (файле).

Синтаксис

class CDockState : public CObject

Участники

Открытые методы

Имя	Описание
CDockState::Clear	Очищает сведения о состоянии док-станции.
CDockState::GetVersion	Извлекает номер версии состояния хранимой строки.
CDockState::LoadState	Извлекает сведения о состоянии из реестра или . INI-файл.
CDockState::SaveState	Сохраняет сведения о состоянии в реестре или INI-файле.

Открытые члены данных

Имя	Описание
CDockState::m_arrBarInfo	Массив указателей на сохраненные сведения о состоянии док-станции с одной записью для каждой панели управления.

Замечания

Состояние док-станции включает размер и позицию панели, а также то, закреплена ли она. При получении сохраненного состояния CDockState док-станции проверяет положение панели и, если панель не отображается с текущими параметрами экрана, масштабирует положение панели таким CDockState образом, чтобы она была видна. Основная цель CDockState состоит в том, чтобы сохранить и загрузить это состояние в реестр, а также обеспечить сохранение и загрузку этого состояния в реестр. INI-файл или в двоичной форме в составе содержимого CArchive объекта.

Панель может быть любой закрепления панели управления, включая панель инструментов, строку состояния или диалоговое окно. CDockState объекты записываются и считываются в файл или из файла с помощью CArchive объекта.

CFrameWnd::GetDockState извлекает сведения о состоянии всех объектов окна CControlBar кадра и помещает его в CDockState объект. Затем можно написать содержимое CDockState объекта в хранилище с помощью Serialize или CDockState::SaveState. Если позже вы хотите восстановить состояние панели управления в окне кадра, можно загрузить состояние с Serialize помощью CDockState::LoadState, а затем использовать CFrameWnd::SetDockState для применения сохраненного состояния к панели управления окна кадра.

Дополнительные сведения о закреплении панелей управления см. в статьях "Панели управления", "Панели инструментов": "Закрепление" и "Плавающий" и "Окна кадров".

Иерархия наследования

CObject

CDockState

Требования

Заголовок: afxadv.h

CDockState::Clear

Вызовите эту функцию, чтобы очистить все сведения о закреплении, хранящиеся в объекте CDockState .

void Clear();

Замечания

К ним относятся не только закрепление панели, но и размер и положение панели, а также видна ли она.

CDockState::GetVersion

Вызовите эту функцию, чтобы получить номер версии состояния хранимой строки.

DWORD GetVersion();

Возвращаемое значение

1, если хранимая линейчатая информация старше текущего состояния строки; 2, если хранимая линейчатая информация совпадает с текущим состоянием панели.

Замечания

Поддержка версий позволяет измененной панели добавлять новые постоянные свойства и по-прежнему иметь возможность обнаруживать и загружать постоянное состояние, созданное более ранней версией панели.

CDockState::LoadState

Вызовите эту функцию для получения сведений о состоянии из реестра или . INI-файл.

void LoadState(LPCTSTR lpszProfileName);

Параметры

lpszProfileName
Указывает на строку, завершающую значение NULL, которая указывает имя раздела в файле инициализации или ключ в реестре Windows, где хранятся сведения о состоянии.

Замечания

Имя профиля — это раздел приложения. INI-файл или реестр, содержащий сведения о состоянии баров. Вы можете сохранить сведения о состоянии панели управления в реестре или . INI-файл с SaveState.

CDockState::m_arrBarInfo

CPtrArray Объект, представляющий собой массив указателей на хранимую информацию панели управления для каждой панели управления, которая сохранила сведения о состоянии в объектеCDockState.

CPtrArray m_arrBarInfo;

CDockState::SaveState

Вызовите эту функцию, чтобы сохранить сведения о состоянии в реестре или . INI-файл.

void SaveState(LPCTSTR lpszProfileName);

Параметры

lpszProfileName
Указывает на строку со значением NULL, указывающую имя раздела в файле инициализации или ключ в реестре Windows, где хранятся сведения о состоянии.

Замечания

Имя профиля — это раздел приложения. INI-файл или реестр, содержащий сведения о состоянии панели управления. SaveState также сохраняет текущий размер экрана. Вы можете получить сведения о панели управления из реестра или . INI-файл с LoadState.

См. также

Класс CObject
Диаграмма иерархии