Condividi tramite

Classe COleDocObjectItem

  • Articolo

Implementa Active Document Containment.

Sintassi

class COleDocObjectItem : public COleClientItem

Membri

Costruttori pubblici

Nome Descrizione
COleDocObjectItem::COleDocObjectItem Costruisce un COleDocObject elemento.

Metodi pubblici

Nome Descrizione
COleDocObjectItem::D oDefaultPrinting Stampa il documento dell'applicazione contenitore usando le impostazioni predefinite della stampante.
COleDocObjectItem::ExecCommand Esegue il comando specificato dall'utente.
COleDocObjectItem::GetActiveView Recupera la visualizzazione attiva del documento.
COleDocObjectItem::GetPageCount Recupera il numero di pagine nel documento dell'applicazione contenitore.
COleDocObjectItem::OnPreparePrinting Prepara il documento dell'applicazione contenitore per la stampa.
COleDocObjectItem::OnPrint Stampa il documento dell'applicazione contenitore.
COleDocObjectItem::QueryCommand Query per lo stato di uno o più comandi generati dagli eventi dell'interfaccia utente.
COleDocObjectItem::Release Rilascia la connessione a un elemento collegato OLE e la chiude se era aperta. Non elimina definitivamente l'elemento client.

Osservazioni:

In MFC un documento attivo viene gestito in modo analogo a un normale incorporamento modificabile sul posto, con le differenze seguenti:

  • La COleDocumentclasse derivata da mantiene ancora un elenco degli elementi attualmente incorporati. Tuttavia, questi elementi possono essere COleDocObjectItemelementi derivati da .

  • Quando un documento attivo è attivo, occupa l'intera area client della visualizzazione quando è attiva sul posto.

  • Un contenitore di documenti attivi ha il controllo completo del menu ?

  • Il menu ? contiene voci di menu sia per il contenitore di documenti attivi che per il server.

Poiché il contenitore Documento attivo è proprietario del menu ? , il contenitore è responsabile dell'inoltro dei messaggi di menu della Guida del server al server. Questa integrazione viene gestita da COleDocObjectItem.

Per altre informazioni sull'unione dei menu e sull'attivazione di documenti attivi, vedere Panoramica del contenimento dei documenti attivi.

Gerarchia di ereditarietà

CObject

CCmdTarget

CDocItem

COleClientItem

COleDocObjectItem

Requisiti

Intestazione: afxole.h

COleDocObjectItem::COleDocObjectItem

Chiamare questa funzione membro per inizializzare l'oggetto COleDocObjectItem .

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parametri

pContainerDoc
Puntatore all'oggetto COleDocument che funge da contenitore di documenti attivo. Questo parametro deve essere NULL per abilitare IMPLEMENT_SERIALIZE. In genere, gli elementi OLE vengono costruiti con un puntatore al documento non NULL.

COleDocObjectItem::D oDefaultPrinting

Chiamato dal framework in un documento usando le impostazioni predefinite.

static HRESULT DoDefaultPrinting(
    CView* pCaller,
    CPrintInfo* pInfo);

Parametri

pCaller
Puntatore a un oggetto CView che invia il comando di stampa.

pInfo
Puntatore a un oggetto CPrintInfo che descrive il processo da stampare.

COleDocObjectItem::ExecCommand

Chiamare questa funzione membro per eseguire il comando specificato dall'utente.

HRESULT ExecCommand(
    DWORD nCmdID,
    DWORD nCmdExecOpt = OLECMDEXECOPT_DONTPROMPTUSER,
    const GUID* pguidCmdGroup = NULL);

Parametri

nCmdID
Identificatore del comando da eseguire. Deve trovarsi nel gruppo identificato da pguidCmdGroup.

nCmdExecOpt
Specifica le opzioni di esecuzione dei comandi. Per impostazione predefinita, impostare per eseguire il comando senza chiedere conferma all'utente. Per un elenco di valori, vedere OLECMDEXECOPT .

pguidCmdGroup
Identificatore univoco del gruppo di comandi. Per impostazione predefinita, NULL, che specifica il gruppo standard. Il comando passato in nCmdID deve appartenere al gruppo.

Valore restituito

Restituisce S_OK se ha esito positivo; in caso contrario, restituisce uno dei codici di errore seguenti.

valore Descrizione
E_UNEXPECTED Si è verificato un errore imprevisto.
E_FAIL Si è verificato un errore.
E_NOTIMPL Indica che MFC deve tentare di tradurre e inviare il comando.
OLECMDERR_E_UNKNOWNGROUP pguidCmdGroup non è NULL, ma non specifica un gruppo di comandi riconosciuto.
OLECMDERR_E_NOTSUPPORTED nCmdID non viene riconosciuto come comando valido nel gruppo pGroup.
OLECMDERR_DISABLED Il comando identificato da nCmdID è disabilitato e non può essere eseguito.
OLECMDERR_NOHELP Il chiamante ha chiesto assistenza sul comando identificato da nCmdID , ma non è disponibile alcuna guida.
OLECMDERR_CANCELLED L'utente ha annullato l'esecuzione.

Osservazioni:

I parametri pguidCmdGroup e nCmdID identificano in modo univoco il comando da richiamare. Il parametro nCmdExecOpt specifica l'azione esatta da eseguire.

COleDocObjectItem::GetActiveView

Chiamare questa funzione membro per ottenere un puntatore all'interfaccia IOleDocumentView della visualizzazione attualmente attiva.

LPOLEDOCUMENTVIEW GetActiveView() const;

Valore restituito

Puntatore all'interfaccia IOleDocumentView della visualizzazione attualmente attiva. Se non è presente alcuna visualizzazione corrente, restituisce NULL.

Osservazioni:

Il conteggio dei riferimenti sul puntatore restituito IOleDocumentView non viene incrementato prima che venga restituito da questa funzione.

COleDocObjectItem::GetPageCount

Chiamare questa funzione membro per recuperare il numero di pagine nel documento.

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parametri

pnFirstPage
Puntatore al numero della prima pagina del documento. Può essere NULL, che indica che il chiamante non ha bisogno di questo numero.

pcPages
Puntatore al numero totale di pagine nel documento. Può essere NULL, che indica che il chiamante non ha bisogno di questo numero.

Valore restituito

Diverso da zero se ha esito positivo; in caso contrario 0.

COleDocObjectItem::OnPreparePrinting

Questa funzione membro viene chiamata dal framework per preparare un documento per la stampa.

static BOOL OnPreparePrinting(
    CView* pCaller,
    CPrintInfo* pInfo,
    BOOL bPrintAll = TRUE);

Parametri

pCaller
Puntatore a un oggetto CView che invia il comando di stampa.

pInfo
Puntatore a un oggetto CPrintInfo che descrive il processo da stampare.

bPrintAll
Specifica se l'intero documento deve essere stampato.

Valore restituito

Diverso da zero se ha esito positivo; in caso contrario 0.

COleDocObjectItem::OnPrint

Questa funzione membro viene chiamata dal framework per stampare un documento.

static void OnPrint(
    CView* pCaller,
    CPrintInfo* pInfo,
    BOOL bPrintAll = TRUE);

Parametri

pCaller
Puntatore a un oggetto CView che invia il comando di stampa.

pInfo
Puntatore a un oggetto CPrintInfo che descrive il processo da stampare.

bPrintAll
Specifica se l'intero documento deve essere stampato.

COleDocObjectItem::QueryCommand

Query per lo stato di uno o più comandi generati dagli eventi dell'interfaccia utente.

HRESULT QueryCommand(
    ULONG nCmdID,
    DWORD* pdwStatus,
    OLECMDTEXT* pCmdText =NULL,
    const GUID* pguidCmdGroup =NULL);

Parametri

nCmdID
identificatore del comando sottoposto a query.

pdwStatus
Puntatore ai flag restituiti come risultato della query. Per un elenco dei valori possibili, vedere OLECMDF.

pCmdText
Puntatore a una struttura OLECMDTEXT in cui restituire informazioni sul nome e sullo stato per un singolo comando. Può essere NULL per indicare che il chiamante non necessita di queste informazioni.

pguidCmdGroup
Identificatore univoco del gruppo di comandi; può essere NULL per specificare il gruppo standard.

Valore restituito

Per un elenco completo dei valori restituiti, vedere IOleCommandTarget::QueryStatus in Windows SDK.

Osservazioni:

Questa funzione membro emula la funzionalità del metodo IOleCommandTarget::QueryStatus , come descritto in Windows SDK.

COleDocObjectItem::Release

Rilascia la connessione a un elemento collegato OLE e la chiude se era aperta. Non elimina definitivamente l'elemento client.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parametri

dwCloseOption
Flag che specifica in quali circostanze l'elemento OLE viene salvato quando torna allo stato caricato. Per un elenco dei valori possibili, vedere COleClientItem::Close.

Osservazioni:

Non elimina definitivamente l'elemento client.

Vedi anche

MFC Sample MFCBIND
Classe COleClientItem
Grafico della gerarchia
Classe COleClientItem
Classe CDocObjectServerItem