Classe CDockState

Uma classe serializada CObject que carrega, descarrega ou limpa o estado de uma ou mais barras de controlo de acoplamento na memória persistente (um ficheiro).

Sintaxe

class CDockState : public CObject

Membros

Métodos Públicos

Membros de Dados Públicos

Observações

O estado do dock inclui o tamanho e a posição da barra e se está ou não acoplada. Ao recuperar o estado armazenado da dock, CDockState verifica a posição da barra e, se a barra não for visível com as definições atuais do ecrã, CDockState escala a posição da barra para que fique visível. O principal objetivo de CDockState é armazenar todo o estado de várias barras de controlo e permitir que esse estado seja guardado e carregado, quer no registo, quer na aplicação . INI, ou em forma binária como parte do conteúdo de um CArchive objeto.

A barra pode ser qualquer barra de controlo acoplável, incluindo uma barra de ferramentas, barra de estado ou barra de diálogo. CDockState os objetos são escritos e lidos para ou a partir de um ficheiro através de um CArchive objeto.

CFrameWnd::GetDockState recupera a informação de estado de todos os objetos da CControlBar janela de frame e coloca-a no CDockState objeto. Pode então escrever o conteúdo do CDockState objeto para armazenamento com Serialize ou CDockState::SaveState. Se mais tarde quiseres restaurar o estado das barras de controlo na janela do frame, podes carregar o estado com Serialize ou CDockState::LoadState, depois usar CFrameWnd::SetDockState para aplicar o estado guardado às barras de controlo da janela do frame.

Para mais informações sobre barras de controlo de acoplamento, consulte os artigos Barras de Controlo, Barras de Ferramentas: Acoplamento e Flutuação, e Janelas de Frames.

Hierarquia de herança

CObject

CDockState

Requerimentos

Cabeçalho: afxadv.h

CDockState::Limpo

Chame esta função para limpar toda a informação de docking armazenada no CDockState objeto.

void Clear();

Observações

Isto inclui não só se a barra está abaixada ou não, mas também o tamanho e posição da barra e se é visível ou não.

CDockState::GetVersion

Chame esta função para recuperar o número de versão do estado de barra armazenado.

DWORD GetVersion();

Valor de retorno

1 se a informação armazenada da barra for mais antiga do que o estado atual da barra; 2 se a informação armazenada da barra for igual ao estado atual da barra.

Observações

O suporte de versões permite que uma barra revista adicione novas propriedades persistentes e ainda consiga detetar e carregar o estado persistente criado por uma versão anterior da barra.

CDockState::LoadState

Chame esta função para recuperar informação de estado do registo ou . Ficheiro INI.

void LoadState(LPCTSTR lpszProfileName);

Parâmetros

lpszProfileName
Aponta para uma cadeia terminada por nulo que especifica o nome de uma secção no ficheiro de inicialização ou uma chave no registo do Windows onde a informação de estado é armazenada.

Observações

O nome do perfil é a secção da aplicação . INI ou o registo que contém a informação de estado das barras. Pode guardar a informação do estado da barra de controlo no registo ou . Ficheiro INI com SaveState.

CDockState::m_arrBarInfo

Um CPtrArray objeto que é um array de apontadores para a informação armazenada da barra de controlo para cada barra de controlo que tenha informação de estado guardada no CDockState objeto.

CPtrArray m_arrBarInfo;

CDockState::SaveState

Chame esta função para guardar a informação do estado no registo ou . Ficheiro INI.

void SaveState(LPCTSTR lpszProfileName);

Parâmetros

lpszProfileName
Aponta para uma cadeia nula-teminada que especifica o nome de uma secção no ficheiro de inicialização ou uma chave no registo do Windows onde a informação de estado é armazenada.

Observações

O nome do perfil é a secção da aplicação . INI ou o registo que contém a informação de estado da barra de controlo. SaveState Também guarda o tamanho atual do ecrã. Pode recuperar informação da barra de controlo do registo ou de . Ficheiro INI com LoadState.

Consulte também

Classe CObject
Gráfico de Hierarquia