Share via

COleDocObjectItem-klasse

Opmerking

De Microsoft Foundation Classes-bibliotheek (MFC) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

Implementeert actieve documentsluiting.

Syntaxis

class COleDocObjectItem : public COleClientItem

Leden

Openbare constructors

Naam Description
COleDocObjectItem::COleDocObjectItem Maakt een COleDocObject item.

Openbare methoden

Naam Description
COleDocObjectItem::D oDefaultPrinting Hiermee drukt u het document van de containertoepassing af met behulp van de standaardprinterinstellingen.
COleDocObjectItem::ExecCommand Hiermee wordt de opdracht uitgevoerd die is opgegeven door de gebruiker.
COleDocObjectItem::GetActiveView Hiermee wordt de actieve weergave van het document opgehaald.
COleDocObjectItem::GetPageCount Hiermee haalt u het aantal pagina's in het document van de containertoepassing op.
COleDocObjectItem::OnPreparePrinting Bereidt het document van de containertoepassing voor op afdrukken.
COleDocObjectItem::OnPrint Hiermee wordt het document van de containertoepassing afgedrukt.
COleDocObjectItem::QueryCommand Query's voor de status van een of meer opdrachten die worden gegenereerd door gebeurtenissen van de gebruikersinterface.
COleDocObjectItem::Release Hiermee wordt de verbinding met een gekoppeld OLE-item vrijgegeven en gesloten als het is geopend. Vernietigt het clientitem niet.

Opmerkingen

In MFC wordt een actief document op dezelfde manier verwerkt als een reguliere, in-place bewerkbare insluiting, met de volgende verschillen:

  • De COleDocument-afgeleide klasse onderhoudt nog steeds een lijst met de momenteel ingesloten items. Deze items kunnen echter -afgeleide items zijn COleDocObjectItem.

  • Wanneer een actief document actief is, neemt het het hele clientgebied van de weergave in beslag wanneer het actief is.

  • Een actieve documentcontainer heeft volledige controle over het Menu Help .

  • Het Menu Help bevat menu-items voor zowel de actieve documentcontainer als de server.

Omdat de actieve documentcontainer eigenaar is van het Menu Help , is de container verantwoordelijk voor het doorsturen van menuberichten van de Server Help naar de server. Deze integratie wordt verwerkt door COleDocObjectItem.

Zie Overzicht van actieve documentsluiting voor meer informatie over het samenvoegen van menu's en actieve documentactivering.

Overnamehiërarchie

CObject

CCmdTarget

CDocItem

COleClientItem

COleDocObjectItem

Requirements

Koptekst: afxole.h

COleDocObjectItem::COleDocObjectItem

Roep deze lidfunctie aan om het COleDocObjectItem object te initialiseren.

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parameterwaarden

pContainerDoc
Een aanwijzer naar het COleDocument object dat fungeert als de actieve documentcontainer. Deze parameter moet NULL zijn om IMPLEMENT_SERIALIZE in te schakelen. Ole-items worden normaal gesproken samengesteld met een niet-NULL-documentpointer.

COleDocObjectItem::D oDefaultPrinting

Aangeroepen door het framework naar een document met behulp van de standaardinstellingen.

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

Parameterwaarden

pCaller
Een aanwijzer naar een CView-object dat de afdrukopdracht verzendt.

Pinfo
Een aanwijzer naar een CPrintInfo-object dat de taak beschrijft die moet worden afgedrukt.

COleDocObjectItem::ExecCommand

Roep deze lidfunctie aan om de opdracht uit te voeren die is opgegeven door de gebruiker.

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

Parameterwaarden

nCmdID
De id van de opdracht die moet worden uitgevoerd. Moet zich in de groep bevinden die is geïdentificeerd door pguidCmdGroup.

nCmdExecOpt
Hiermee geeft u opties voor opdrachtuitvoering. Standaard moet u de opdracht uitvoeren zonder de gebruiker te vragen. Zie OLECMDEXECOPT voor een lijst met waarden.

pguidCmdGroup
Unieke id van de opdrachtgroep. Standaard NULL, waarmee de standaardgroep wordt opgegeven. De opdracht die is doorgegeven in nCmdID , moet deel uitmaken van de groep.

Retourwaarde

Retourneert S_OK indien geslaagd; retourneert anders een van de volgende foutcodes.

Waarde Description
E_UNEXPECTED Er is een onverwachte fout opgetreden.
E_FAIL Er is een fout opgetreden.
E_NOTIMPL Geeft aan dat MFC zelf de opdracht moet vertalen en verzenden.
OLECMDERR_E_UNKNOWNGROUP pguidCmdGroup is niet null, maar geeft geen herkende opdrachtgroep op.
OLECMDERR_E_NOTSUPPORTED nCmdID wordt niet herkend als een geldige opdracht in de groep pGroup.
OLECMDERR_DISABLED De opdracht die wordt geïdentificeerd door nCmdID is uitgeschakeld en kan niet worden uitgevoerd.
OLECMDERR_NOHELP De beller heeft om hulp gevraagd voor de opdracht die is geïdentificeerd door nCmdID , maar er is geen help beschikbaar.
OLECMDERR_CANCELLED De gebruiker heeft de uitvoering geannuleerd.

Opmerkingen

De pguidCmdGroup en de parameters nCmdID identificeren samen de opdracht die moet worden aangeroepen. De parameter nCmdExecOpt geeft de exacte actie op die moet worden uitgevoerd.

COleDocObjectItem::GetActiveView

Roep deze lidfunctie aan om een aanwijzer te krijgen naar de IOleDocumentView interface van de momenteel actieve weergave.

LPOLEDOCUMENTVIEW GetActiveView() const;

Retourwaarde

Een aanwijzer naar de IOleDocumentView-interface van de huidige actieve weergave. Als er geen huidige weergave is, wordt NULL geretourneerd.

Opmerkingen

Het aantal verwijzingen op de geretourneerde IOleDocumentView aanwijzer wordt niet verhoogd voordat deze door deze functie wordt geretourneerd.

COleDocObjectItem::GetPageCount

Roep deze lidfunctie aan om het aantal pagina's in het document op te halen.

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parameterwaarden

pnFirstPage
Een aanwijzer naar het nummer van de eerste pagina van het document. Kan NULL zijn, wat aangeeft dat de beller dit nummer niet nodig heeft.

pcPages
Een aanwijzer naar het totale aantal pagina's in het document. Kan NULL zijn, wat aangeeft dat de beller dit nummer niet nodig heeft.

Retourwaarde

Niet-nul indien geslaagd; anders 0.

COleDocObjectItem::OnPreparePrinting

Deze lidfunctie wordt aangeroepen door het framework om een document voor te bereiden voor afdrukken.

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

Parameterwaarden

pCaller
Een aanwijzer naar een CView-object dat de afdrukopdracht verzendt.

Pinfo
Een aanwijzer naar een CPrintInfo-object dat de taak beschrijft die moet worden afgedrukt.

bPrintAll
Hiermee geeft u op of het hele document moet worden afgedrukt.

Retourwaarde

Niet-nul indien geslaagd; anders 0.

COleDocObjectItem::OnPrint

Deze lidfunctie wordt aangeroepen door het framework om een document af te drukken.

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

Parameterwaarden

pCaller
Een aanwijzer naar een CView-object dat de afdrukopdracht verzendt.

Pinfo
Een aanwijzer naar een CPrintInfo-object dat de taak beschrijft die moet worden afgedrukt.

bPrintAll
Hiermee geeft u op of het hele document moet worden afgedrukt.

COleDocObjectItem::QueryCommand

Query's voor de status van een of meer opdrachten die worden gegenereerd door gebeurtenissen van de gebruikersinterface.

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

Parameterwaarden

nCmdID
id van de opdracht waarvoor een query wordt uitgevoerd.

pdwStatus
Een aanwijzer naar de vlaggen die als resultaat van de query worden geretourneerd. Zie OLECMDF voor een lijst met mogelijke waarden.

pCmdText
Wijs een OLECMDTEXT-structuur aan waarin naam- en statusinformatie voor één opdracht moeten worden geretourneerd. Kan NULL zijn om aan te geven dat de beller deze informatie niet nodig heeft.

pguidCmdGroup
Unieke id van de opdrachtgroep; kan NULL zijn om de standaardgroep op te geven.

Retourwaarde

Zie IOleCommandTarget::QueryStatus in de Windows SDK voor een volledige lijst met retourwaarden.

Opmerkingen

Deze lidfunctie emuleert de functionaliteit van de methode IOleCommandTarget::QueryStatus , zoals beschreven in de Windows SDK.

COleDocObjectItem::Release

Hiermee wordt de verbinding met een gekoppeld OLE-item vrijgegeven en gesloten als het is geopend. Vernietigt het clientitem niet.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parameterwaarden

dwCloseOption
Vlag die aangeeft onder welke omstandigheden het OLE-item wordt opgeslagen wanneer het terugkeert naar de geladen status. Zie COleClientItem::Close voor een lijst met mogelijke waarden.

Opmerkingen

Vernietigt het clientitem niet.

Zie ook

MFC-voorbeeld MFCBIND
COleClientItem-klasse
Hiërarchiegrafiek
COleClientItem-klasse
CDocObjectServerItem-klasse

  • Last updated on