CDockState (clase)

Una clase serializada CObject que carga, descarga o desactiva el estado de una o más barras de control de acoplamiento en memoria persistente (un archivo).

Sintaxis

class CDockState : public CObject

Miembros

Métodos públicos

Nombre	Descripción
CDockState::Clear	Borra la información de estado de acoplamiento.
CDockState::GetVersion	Recupera el número de versión del estado de la barra almacenada.
CDockState::LoadState	Recupera información de estado del registro o del archivo .INI.
CDockState::SaveState	Guarda la información de estado en el registro o el archivo .INI.

Miembros de datos públicos

Nombre	Descripción
CDockState::m_arrBarInfo	Matriz de punteros a la información de estado de acoplamiento almacenada con una entrada para cada barra de control.

Comentarios

El estado de acoplamiento incluye el tamaño y la posición de la barra y si está acoplada o no. Al recuperar el estado de acoplamiento almacenado, CDockState comprueba la posición de la barra y, si la barra no está visible con la configuración de pantalla actual, CDockState escala la posición de la barra para que sea visible. El propósito principal de CDockState es contener todo el estado de una serie de barras de control y permitir que ese estado se guarde y cargue en el registro, en el archivo .INI de la aplicación o en formato binario como parte del contenido de un objeto CArchive.

La barra puede ser cualquier barra de control acoplable, incluida una barra de herramientas, una barra de estado o una barra de cuadro de diálogo. Los objetos CDockState se escriben y leen en un archivo a través de un objeto CArchive.

CFrameWnd::GetDockState recupera la información de estado de todos los objetos CControlBar de la ventana de marco y la coloca en el objeto CDockState. A continuación, puede escribir el contenido del objeto CDockState en el almacenamiento con Serialize o CDockState::SaveState. Si más adelante quiere restaurar el estado de las barras de control en la ventana de marco, puede cargar el estado con Serialize o CDockState::LoadState, use CFrameWnd::SetDockState para aplicar el estado guardado a las barras de control de la ventana de marco.

Para más información sobre las barras de control de acoplamiento, vea los artículos Barras de control, Barras de herramientas: de acoplamiento y flotantes y Ventanas de marco.

Jerarquía de herencia

CObject

CDockState

Requisitos

Encabezado: afxadv.h

CDockState::Clear

Llame a esta función para borrar toda la información de acoplamiento almacenada en el objeto CDockState.

void Clear();

Comentarios

Esto incluye no solo si la barra está acoplada o no, sino también el tamaño y la posición de la barra y si está visible o no.

CDockState::GetVersion

Llame a esta función para recuperar el número de versión del estado de la barra almacenada.

DWORD GetVersion();

Valor devuelto

1 si la información de la barra almacenada es anterior al estado actual de la barra; 2 si la información de la barra almacenada es la misma que el estado de la barra actual.

Comentarios

La compatibilidad con versiones permite que una barra revisada agregue nuevas propiedades persistentes y pueda detectar y cargar el estado persistente creado por una versión anterior de la barra.

CDockState::LoadState

Llame a esta función para recuperar información de estado del registro o del archivo .INI.

void LoadState(LPCTSTR lpszProfileName);

Parámetros

lpszProfileName
Apunta a una cadena terminada en NULL que especifica el nombre de una sección en el archivo de inicialización o una clave del Registro de Windows donde se almacena la información de estado.

Comentarios

El nombre del perfil es la sección del archivo .INI de la aplicación o del registro que contiene la información de estado de las barras. Puede guardar la información de estado de la barra de control en el registro o el archivo .INI con SaveState.

CDockState::m_arrBarInfo

Objeto CPtrArray que es una matriz de punteros a la información de barra de control almacenada para cada barra de control que ha guardado información de estado en el objeto CDockState.

CPtrArray m_arrBarInfo;

CDockState::SaveState

Llame a esta función para guardar la información de estado en el registro o el archivo .INI.

void SaveState(LPCTSTR lpszProfileName);

Parámetros

lpszProfileName
Apunta a una cadena terminada en NULL que especifica el nombre de una sección en el archivo de inicialización o una clave del registro de Windows donde se almacena la información de estado.

Comentarios

El nombre del perfil es la sección del archivo .INI de la aplicación o del registro que contiene la información de estado de las barras de control. SaveState también guarda el tamaño de pantalla actual. Puede recuperar la información de la barra de control del registro o el archivo .INI con LoadState.

Consulte también

CObject (clase)
Gráfico de jerarquías