CDockState, classe

Classe CObject sérialisée qui charge, décharge ou désactive l'état d'une ou de plusieurs barres de contrôles d'ancrage en mémoire persistante (un fichier).

Syntaxe

class CDockState : public CObject

Membres

Méthodes publiques

Nom	Description
CDockState ::Clear	Efface les informations d’état d’ancrage.
CDockState ::GetVersion	Récupère le numéro de version de l’état de la barre stockée.
CDockState ::LoadState	Récupère les informations d’état du Registre ou . Fichier INI.
CDockState ::SaveState	Enregistre les informations d’état dans le registre ou le fichier INI.

Membres de données publics

Nom	Description
CDockState ::m_arrBarInfo	Tableau de pointeurs vers les informations d’état d’ancrage stockées avec une entrée pour chaque barre de contrôle.

Notes

L’état de la station d’accueil inclut la taille et la position de la barre et indique si elle est ancrée ou non. Lors de la récupération de l’état d’ancrage stocké, CDockState case activée la position de la barre et, si la barre n’est pas visible avec les paramètres d’écran actuels, CDockState met à l’échelle la position de la barre afin qu’elle soit visible. L’objectif principal est CDockState de contenir l’état entier d’un certain nombre de barres de contrôle et de permettre à cet état d’être enregistré et chargé dans le Registre, l’application. Fichier INI ou sous forme binaire dans le cadre du contenu d’un CArchive objet.

La barre peut être n’importe quelle barre de contrôle ancre, y compris une barre d’outils, une barre d’état ou une barre de dialogue. CDockState les objets sont écrits et lus dans ou à partir d’un fichier via un CArchive objet.

CFrameWnd ::GetDockState récupère les informations d’état de tous les objets de CControlBar la fenêtre frame et les place dans l’objet CDockState . Vous pouvez ensuite écrire le contenu de l’objet dans le CDockState stockage avec Serialize ou CDockState ::SaveState. Si vous souhaitez ultérieurement restaurer l’état des barres de contrôle dans la fenêtre frame, vous pouvez charger l’état avec Serialize ou CDockState ::LoadState, puis utiliser CFrameWnd ::SetDockState pour appliquer l’état enregistré aux barres de contrôle de la fenêtre frame.

Pour plus d’informations sur l’ancrage des barres de contrôle, consultez les articles Barres de contrôle, Barres d’outils : Ancrage et flottant et Fenêtres frame.

Hiérarchie d'héritage

CObject

CDockState

Spécifications

En-tête : afxadv.h

CDockState ::Clear

Appelez cette fonction pour effacer toutes les informations d’ancrage stockées dans l’objet CDockState .

void Clear();

Notes

Cela inclut non seulement si la barre est ancrée ou non, mais la taille et la position de la barre et si elle est visible ou non.

CDockState ::GetVersion

Appelez cette fonction pour récupérer le numéro de version de l’état de la barre stockée.

DWORD GetVersion();

Valeur de retour

1 si les informations de barre stockée sont antérieures à l’état actuel de la barre ; 2 si les informations de barre stockée sont identiques à l’état actuel de la barre.

Notes

La prise en charge des versions permet à une barre révisée d’ajouter de nouvelles propriétés persistantes et de pouvoir détecter et charger l’état persistant créé par une version antérieure de la barre.

CDockState ::LoadState

Appelez cette fonction pour récupérer les informations d’état à partir du Registre ou . Fichier INI.

void LoadState(LPCTSTR lpszProfileName);

Paramètres

lpszProfileName
Pointe vers une chaîne terminée par null qui spécifie le nom d’une section dans le fichier d’initialisation ou une clé dans le Registre Windows où les informations d’état sont stockées.

Notes

Le nom du profil est la section de l’application. Fichier INI ou registre qui contient les informations d’état des barres. Vous pouvez enregistrer les informations d’état de la barre de contrôle dans le Registre ou . Fichier INI avec SaveState.

CDockState ::m_arrBarInfo

Objet CPtrArray qui est un tableau de pointeurs vers les informations de barre de contrôle stockées pour chaque barre de contrôle qui a enregistré des informations d’état dans l’objet CDockState .

CPtrArray m_arrBarInfo;

CDockState ::SaveState

Appelez cette fonction pour enregistrer les informations d’état dans le Registre ou . Fichier INI.

void SaveState(LPCTSTR lpszProfileName);

Paramètres

lpszProfileName
Pointe vers une chaîne null-téminée qui spécifie le nom d’une section dans le fichier d’initialisation ou une clé dans le Registre Windows où les informations d’état sont stockées.

Notes

Le nom du profil est la section de l’application. Fichier INI ou registre qui contient les informations d’état de la barre de contrôle. SaveState enregistre également la taille actuelle de l’écran. Vous pouvez récupérer des informations de barre de contrôle à partir du Registre ou . Fichier INI avec LoadState.

Voir aussi

CObject, classe
Graphique hiérarchique