CDocument, classe

Article
06/10/2015

Fournit les fonctionnalités de base des classes définies par l'utilisateur de document.

class CDocument : public CCmdTarget

Membres

Constructeurs publics

Nom	Description
CDocument::CDocument	Construit un objet CDocument.

Méthodes publiques

Nom	Description
CDocument::AddView	Joint une vue au document.
CDocument::BeginReadChunks	Initialise la lecture du segment.
CDocument::CanCloseFrame	Substituable avancées ; appelé avant de fermer une fenêtre frame consultant ce document.
CDocument::ClearChunkList	Efface la liste de segment.
CDocument::ClearPathName	Efface le chemin d'accès de l'objet.
CDocument::DeleteContents	Appelé pour effectuer un nettoyage du document.
CDocument::FindChunk	Recherche un segment avec un GUID spécifié.
CDocument::GetAdapter	Retourne un pointeur pour un objet implémentant l'interface d' IDocument .
CDocument::GetDocTemplate	Retourne un pointeur vers le modèle de document qui décrit le type du document.
CDocument::GetFile	Retourne un pointeur vers l'objet souhaité dans CFile .
CDocument::GetFirstViewPosition	Retourne la position de la première dans la liste des vues ; utilisé pour lancer l'itération.
CDocument::GetNextView	Itère au sein de la liste de vues associées au document.
CDocument::GetPathName	Retourne le chemin d'accès du fichier de données du document.
CDocument::GetThumbnail	Appelé pour créer une bitmap à utiliser par le fournisseur miniature pour afficher l'aperçu.
CDocument::GetTitle	Retourne le titre du document.
CDocument::InitializeSearchContent	Appelé pour initialiser le contenu de recherche pour le gestionnaire de recherche.
CDocument::IsModified	Indique si le document a été modifié depuis lequel il a été en dernier enregistrement.
CDocument::IsSearchAndOrganizeHandler	Indique si cette instance d'objet d' CDocument a été créée pour la recherche et organise le gestionnaire.
CDocument::LoadDocumentFromStream	Appelé aux données de document de chargement du flux.
CDocument::OnBeforeRichPreviewFontChanged	Appelé avant la police d'aperçu riche est modifié.
CDocument::OnChangedViewList	Appelé après une vue soit ajoutée ou supprimée du document.
CDocument::OnCloseDocument	Appelé pour fermer le document.
CDocument::OnCreatePreviewFrame	Appelé par l'infrastructure lorsqu'il doit créer un frame d'aperçu de l'aperçu riche.
CDocument::OnDocumentEvent	Appelé par l'infrastructure en réponse à un événement de document.
CDocument::OnDrawThumbnail	Substituez cette méthode dans une classe dérivée pour dessiner le contenu de l'aperçu.
CDocument::OnLoadDocumentFromStream	Appelé par l'infrastructure lorsqu'il doit charger des données de document du flux.
CDocument::OnNewDocument	Appelé pour créer un document.
CDocument::OnOpenDocument	Appelé pour ouvrir un document existant.
CDocument::OnPreviewHandlerQueryFocus	Dirige le gestionnaire d'aperçu pour retourner le HWND d'appeler la fonction de GetFocus.
CDocument::OnPreviewHandlerTranslateAccelerator	Dirige le gestionnaire d'aperçu pour gérer une séquence de touches passée de la pompe de messages du processus dans lequel le gestionnaire d'aperçu exécute.
CDocument::OnRichPreviewBackColorChanged	Appelé lorsque la couleur d'arrière-plan d'aperçu de riches a changé.
CDocument::OnRichPreviewFontChanged	Appelé lorsque la police d'aperçu de riches a changé.
CDocument::OnRichPreviewSiteChanged	Appelé lorsque le site d'aperçu de riches a changé.
CDocument::OnRichPreviewTextColorChanged	Appelé lorsque la couleur du texte d'aperçu de riches a changé.
CDocument::OnSaveDocument	Appelé pour enregistrer le document sur le disque.
CDocument::OnUnloadHandler	Appelé par l'infrastructure lorsque le gestionnaire d'aperçu est déchargé.
CDocument::PreCloseFrame	Appelé avant la fenêtre frame est fermé.
CDocument::ReadNextChunkValue	La valeur de segment de lectures.
CDocument::ReleaseFile	Libère un fichier pour le rendre disponible pour une utilisation par d'autres applications.
CDocument::RemoveChunk	Supprime un segment avec un GUID spécifié.
CDocument::RemoveView	Détache une vue du document.
CDocument::ReportSaveLoadException	Substituable avancées ; appelé lorsqu'une opération ouvert ou d'enregistrement ne peut pas être effectuée en raison d'une exception.
CDocument::SaveModified	Substituable avancées ; appelé pour indiquer à l'utilisateur si le document doit être enregistré.
CDocument::SetChunkValue	Définit une valeur de segment.
CDocument::SetModifiedFlag	Place une balise qui indique que vous avez modifié le document depuis lequel il a été en dernier enregistrement.
CDocument::SetPathName	Définit le chemin d'accès du fichier de données utilisé par le document.
CDocument::SetTitle	Définit le titre du document.
CDocument::UpdateAllViews	Signale toutes les vues que le document a été modifiées.

Méthodes protégées

Nom	Description
CDocument::OnFileSendMail	Envoie un message électronique avec le document lié.
CDocument::OnUpdateFileSendMail	Active la commande de messagerie d'envoyer si la prise en charge de messagerie est présent.

Données membres publiques

Nom	Description
CDocument::m_bGetThumbnailMode	Spécifie que l'objet d' CDocument a été créé par le dllhost des aperçus. Doit être signé CView::OnDraw.
CDocument::m_bPreviewHandlerMode	Spécifie que l'objet d' CDocument a été créé par le prevhost pour Rich Preview. Doit être signé CView::OnDraw.
CDocument::m_bSearchMode	Spécifie que l'objet d' CDocument a été créé par l'indexeur ou autre application de recherche.
CDocument::m_clrRichPreviewBackColor	Spécifie la couleur d'arrière-plan de la fenêtre d'aperçu riche. Cette couleur est définie par l'hôte.
CDocument::m_clrRichPreviewTextColor	Spécifie la couleur de premier plan de la fenêtre d'aperçu riche. Cette couleur est définie par l'hôte.
CDocument::m_lfRichPreviewFont	Spécifie la police du texte de la fenêtre d'aperçu riche. Ces informations de police sont définies par l'hôte.

Notes

Un document représente l'unité de données que l'utilisateur en général ouvre avec la commande ouverte de fichier et enregistre avec la commande de sauvegarde de fichier.

CDocument prend en charge les opérations standard telles que la création d'un document, le chargement, et l'enregistrer. L'infrastructure manipule des documents à l'aide de l'interface définie par CDocument.

Une application peut prendre en charge plusieurs types de document ; par exemple, une application peut prendre en charge des feuilles et des documents texte. Chaque type de document a un modèle de document associé ; le modèle de document spécifie les ressources (par exemple, menu, icône, ou table d'accélérateurs) sont utilisés pour ce type de document. Chaque document contient un pointeur vers l'objet associé à CDocTemplate .

Les utilisateurs interagissent avec un document par les objets de CView associés à celui-ci. Une vue affiche une image du document dans une fenêtre frame et interprète les entrées d'utilisateur comme opérations sur le document. Un document peut avoir plusieurs affichages associés à celui-ci. Lorsque l'utilisateur ouvre une fenêtre sur un document, l'infrastructure crée une vue et la lié au document. Le modèle de document spécifie le type de vue et de fenêtre frame sont utilisées pour afficher chaque type de document.

Les documents font partie du routage des commandes standard de l'infrastructure et reçoivent par conséquent des commandes des composants standard d'interface utilisateur (tels que l'élément de menu de sauvegarde de fichier). Un document reçoit des commandes faites suivre par la vue active. Si le document ne gère pas la commande donnée, il effectue le suivi de la commande le modèle de document qui gère la.

Lorsque les données d'un document sont modifiées, chacune de ses vues doivent refléter ces modifications. CDocument fournit la fonction membre d' UpdateAllViews pour que vous informiez les vues de ces modifications, les vues peuvent se repeindre si nécessaire. L'infrastructure invite l'utilisateur à enregistrer un fichier modifié avant de le fermer.

Pour implémenter des documents dans une application type, vous devez effectuer les opérations suivantes :

Dérivez une classe de CDocument pour chaque type de document.
Ajoutez des variables membres pour stocker les données de chaque document.
Implémentez les fonctions membres pour lire et modifier les données du document. Les vues du document sont les utilisateurs les plus importants de ces fonctions membres.
Substituez la fonction membre de CObject::Serialize dans votre classe de document pour écrire et lire les données du document vers le disque.

CDocument prend envoyer votre document par le biais de la messagerie si la prise en charge de message MAPI () est présent. Consultez les articles MAPI et Prise en charge MAPI dans MFC.

Pour plus d'informations sur CDocument, consultez sérialisation, Rubriques d'architecture Document/Vue, et le création de document/vue.