COleDocObjectItem, classe
Implémente la relation contenant-contenu de document actif.
Syntaxe
class COleDocObjectItem : public COleClientItem
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| COleDocObjectItem ::COleDocObjectItem | Construit un COleDocObject élément. |
Méthodes publiques
| Nom | Description |
|---|---|
| COleDocObjectItem ::D oDefaultPrinting | Imprime le document de l’application conteneur à l’aide des paramètres d’imprimante par défaut. |
| COleDocObjectItem ::ExecCommand | Exécute la commande spécifiée par l’utilisateur. |
| COleDocObjectItem ::GetActiveView | Récupère l’affichage actif du document. |
| COleDocObjectItem ::GetPageCount | Récupère le nombre de pages dans le document de l’application conteneur. |
| COleDocObjectItem ::OnPreparePrinting | Prépare le document de l’application conteneur pour l’impression. |
| COleDocObjectItem ::OnPrint | Imprime le document de l’application conteneur. |
| COleDocObjectItem ::QueryCommand | Demande l’état d’une ou plusieurs commandes générées par des événements d’interface utilisateur. |
| COleDocObjectItem ::Release | Libère la connexion à un élément lié OLE et la ferme si elle a été ouverte. Ne détruit pas l’élément client. |
Notes
Dans MFC, un document actif est géré de la même façon qu’un incorporation modifiable sur place standard, avec les différences suivantes :
La
COleDocumentclasse dérivée -conserve toujours une liste des éléments actuellement incorporés ; toutefois, ces éléments peuvent êtreCOleDocObjectItemdes éléments dérivés.Lorsqu’un document actif est actif, il occupe toute la zone cliente de l’affichage lorsqu’il est actif sur place.
Un conteneur de documents actif a un contrôle total du menu Aide .
Le menu Aide contient des éléments de menu pour le conteneur de documents actif et le serveur.
Étant donné que le conteneur de documents actif possède le menu d’aide, le conteneur est responsable du transfert des messages du menu d’aide du serveur vers le serveur. Cette intégration est gérée par COleDocObjectItem.
Pour plus d’informations sur la fusion de menus et l’activation du document actif, consultez Vue d’ensemble de l’isolement des documents actifs.
Hiérarchie d'héritage
COleDocObjectItem
Spécifications
En-tête : afxole.h
COleDocObjectItem ::COleDocObjectItem
Appelez cette fonction membre pour initialiser l’objet COleDocObjectItem .
COleDocObjectItem(COleDocument* pContainerDoc = NULL);
Paramètres
pContainerDoc
Pointeur vers l’objet COleDocument agissant comme conteneur de documents actif. Ce paramètre doit être NULL pour activer IMPLEMENT_SERIALIZE. Normalement, les éléments OLE sont construits avec un pointeur de document non NULL.
COleDocObjectItem ::D oDefaultPrinting
Appelé par l’infrastructure à un document à l’aide des paramètres par défaut.
static HRESULT DoDefaultPrinting(
CView* pCaller,
CPrintInfo* pInfo);
Paramètres
pCaller
Pointeur vers un objet CView qui envoie la commande d’impression.
pInfo
Pointeur vers un objet CPrintInfo qui décrit le travail à imprimer.
COleDocObjectItem ::ExecCommand
Appelez cette fonction membre pour exécuter la commande spécifiée par l’utilisateur.
HRESULT ExecCommand(
DWORD nCmdID,
DWORD nCmdExecOpt = OLECMDEXECOPT_DONTPROMPTUSER,
const GUID* pguidCmdGroup = NULL);
Paramètres
nCmdID
Identificateur de la commande à exécuter. Doit se trouver dans le groupe identifié par pguidCmdGroup.
nCmdExecOpt
Spécifie les options d’exécution de commande. Par défaut, définissez pour exécuter la commande sans inviter l’utilisateur. Consultez OLECMDEXECOPT pour obtenir la liste des valeurs.
pguidCmdGroup
Identificateur unique du groupe de commandes. Par défaut, NULL, qui spécifie le groupe standard. La commande passée dans nCmdID doit appartenir au groupe.
Valeur de retour
Retourne S_OK en cas de réussite ; sinon, retourne l’un des codes d’erreur suivants.
| Value | Description |
|---|---|
| E_UNEXPECTED | Une erreur inattendue s'est produite. |
| E_FAIL | Une erreur s’est produite. |
| E_NOTIMPL | Indique que MFC lui-même doit tenter de traduire et de distribuer la commande. |
| OLECMDERR_E_UNKNOWNGROUP | pguidCmdGroup n’est pas NULL, mais ne spécifie pas de groupe de commandes reconnu. |
| OLECMDERR_E_NOTSUPPORTED | nCmdID n’est pas reconnu comme une commande valide dans le groupe pGroup. |
| OLECMDERR_DISABLED | La commande identifiée par nCmdID est désactivée et ne peut pas être exécutée. |
| OLECMDERR_NOHELP | L’appelant a demandé de l’aide sur la commande identifiée par nCmdID , mais aucune aide n’est disponible. |
| OLECMDERR_CANCELLED | L’utilisateur a annulé l’exécution. |
Notes
Les paramètres pguidCmdGroup et nCmdID identifient de manière unique la commande à appeler. Le paramètre nCmdExecOpt spécifie l’action exacte à entreprendre.
COleDocObjectItem ::GetActiveView
Appelez cette fonction membre pour obtenir un pointeur vers l’interface IOleDocumentView de la vue actuellement active.
LPOLEDOCUMENTVIEW GetActiveView() const;
Valeur de retour
Pointeur vers l’interface IOleDocumentView de l’affichage actif. S’il n’y a pas d’affichage actuel, elle retourne NULL.
Notes
Le nombre de références sur le pointeur retourné n’est pas incrémenté IOleDocumentView avant qu’il ne soit retourné par cette fonction.
COleDocObjectItem ::GetPageCount
Appelez cette fonction membre pour récupérer le nombre de pages du document.
BOOL GetPageCount(
LPLONG pnFirstPage,
LPLONG pcPages);
Paramètres
pnFirstPage
Pointeur vers le nombre de la première page du document. Peut être NULL, ce qui indique que l’appelant n’a pas besoin de ce numéro.
pcPages
Pointeur vers le nombre total de pages du document. Peut être NULL, ce qui indique que l’appelant n’a pas besoin de ce numéro.
Valeur de retour
Valeur différente de zéro cas de réussite ; sinon, 0.
COleDocObjectItem ::OnPreparePrinting
Cette fonction membre est appelée par l’infrastructure pour préparer un document pour l’impression.
static BOOL OnPreparePrinting(
CView* pCaller,
CPrintInfo* pInfo,
BOOL bPrintAll = TRUE);
Paramètres
pCaller
Pointeur vers un objet CView qui envoie la commande d’impression.
pInfo
Pointeur vers un objet CPrintInfo qui décrit le travail à imprimer.
bPrintAll
Spécifie si l’intégralité du document doit être imprimé.
Valeur de retour
Valeur différente de zéro cas de réussite ; sinon, 0.
COleDocObjectItem ::OnPrint
Cette fonction membre est appelée par l’infrastructure pour imprimer un document.
static void OnPrint(
CView* pCaller,
CPrintInfo* pInfo,
BOOL bPrintAll = TRUE);
Paramètres
pCaller
Pointeur vers un objet CView qui envoie la commande d’impression.
pInfo
Pointeur vers un objet CPrintInfo qui décrit le travail à imprimer.
bPrintAll
Spécifie si l’intégralité du document doit être imprimé.
COleDocObjectItem ::QueryCommand
Demande l’état d’une ou plusieurs commandes générées par des événements d’interface utilisateur.
HRESULT QueryCommand(
ULONG nCmdID,
DWORD* pdwStatus,
OLECMDTEXT* pCmdText =NULL,
const GUID* pguidCmdGroup =NULL);
Paramètres
nCmdID
identificateur de la commande interrogée pour.
pdwStatus
Pointeur vers les indicateurs retournés à la suite de la requête. Pour obtenir la liste des valeurs possibles, consultez OLECMDF.
pCmdText
Pointeur vers une structure OLECMDTEXT dans laquelle retourner des informations de nom et d’état pour une seule commande. Peut être NULL pour indiquer que l’appelant n’a pas besoin de ces informations.
pguidCmdGroup
Identificateur unique du groupe de commandes ; peut être NULL pour spécifier le groupe standard.
Valeur de retour
Pour obtenir une liste complète des valeurs de retour, consultez IOleCommandTarget ::QueryStatus dans le Kit de développement logiciel (SDK) Windows.
Notes
Cette fonction membre émule les fonctionnalités de la méthode IOleCommandTarget ::QueryStatus , comme décrit dans le Kit de développement logiciel (SDK) Windows.
COleDocObjectItem ::Release
Libère la connexion à un élément lié OLE et la ferme si elle a été ouverte. Ne détruit pas l’élément client.
virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);
Paramètres
dwCloseOption
Indicateur spécifiant dans quelles circonstances l’élément OLE est enregistré lorsqu’il retourne à l’état chargé. Pour obtenir la liste des valeurs possibles, consultez COleClientItem ::Close.
Notes
Ne détruit pas l’élément client.
Voir aussi
Exemple MFC MFCBIND
COleClientItem, classe
Graphique hiérarchique
COleClientItem, classe
CDocObjectServerItem, classe
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour