Share via

Klasa COleDocObjectItem

  • Artykuł

Implementuje zawieranie aktywnych dokumentów.

Składnia

class COleDocObjectItem : public COleClientItem

Członkowie

Konstruktory publiczne

Nazwa/nazwisko opis
COleDocObjectItem::COleDocObjectItem COleDocObject Tworzy element.

Metody publiczne

Nazwa/nazwisko opis
COleDocObjectItem::D oDefaultPrinting Drukuje dokument aplikacji kontenera przy użyciu domyślnych ustawień drukarki.
COleDocObjectItem::ExecCommand Wykonuje polecenie określone przez użytkownika.
COleDocObjectItem::GetActiveView Pobiera aktywny widok dokumentu.
COleDocObjectItem::GetPageCount Pobiera liczbę stron w dokumencie aplikacji kontenera.
COleDocObjectItem::OnPreparePrinting Przygotowuje dokument aplikacji kontenera do drukowania.
COleDocObjectItem::OnPrint Drukuje dokument aplikacji kontenera.
COleDocObjectItem::QueryCommand Wykonuje zapytania dotyczące stanu co najmniej jednego polecenia wygenerowanego przez zdarzenia interfejsu użytkownika.
COleDocObjectItem::Release Zwalnia połączenie z połączonym elementem OLE i zamyka je, jeśli został otwarty. Nie niszczy elementu klienta.

Uwagi

W MFC aktywny dokument jest obsługiwany podobnie do zwykłego, edytowalnego osadzania w miejscu z następującymi różnicami:

  • Klasa -pochodna COleDocumentnadal utrzymuje listę aktualnie osadzonych elementów, jednak te elementy mogą być COleDocObjectItemelementami pochodnymi.

  • Gdy aktywny dokument jest aktywny, zajmuje cały obszar klienta widoku, gdy jest aktywny w miejscu.

  • Kontener aktywnego dokumentu ma pełną kontrolę nad menu Pomoc .

  • Menu Pomoc zawiera elementy menu dla kontenera i serwera Aktywnego dokumentu.

Ponieważ kontener Aktywny dokument jest właścicielem menu Pomoc, kontener jest odpowiedzialny za przekazywanie komunikatów menu Pomocy serwera do serwera. Ta integracja jest obsługiwana przez program COleDocObjectItem.

Aby uzyskać więcej informacji na temat scalania menu i aktywacji aktywnego dokumentu, zobacz Omówienie zawierania dokumentów aktywnych.

Hierarchia dziedziczenia

Cobject

Ccmdtarget

Cdocitem

Coleclientitem

COleDocObjectItem

Wymagania

Nagłówek: afxole.h

COleDocObjectItem::COleDocObjectItem

Wywołaj tę funkcję składową, aby zainicjować COleDocObjectItem obiekt.

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parametry

pContainerDoc
Wskaźnik do COleDocument obiektu działającego jako aktywny kontener dokumentów. Ten parametr musi mieć wartość NULL, aby włączyć IMPLEMENT_SERIALIZE. Zwykle elementy OLE są konstruowane ze wskaźnikiem dokumentu o wartości innej niż NULL.

COleDocObjectItem::D oDefaultPrinting

Wywoływana przez platformę do dokumentu przy użyciu ustawień domyślnych.

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

Parametry

pCaller
Wskaźnik do obiektu CView , który wysyła polecenie drukowania.

Pinfo
Wskaźnik do obiektu CPrintInfo , który opisuje zadanie do wydrukowania.

COleDocObjectItem::ExecCommand

Wywołaj tę funkcję składową, aby wykonać polecenie określone przez użytkownika.

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

Parametry

nCmdID
Identyfikator polecenia do wykonania. Musi znajdować się w grupie zidentyfikowanym przez element pguidCmdGroup.

nCmdExecOpt
Określa opcje wykonywania poleceń. Domyślnie ustaw polecenie , aby wykonać polecenie bez monitowania użytkownika. Aby uzyskać listę wartości, zobacz OLECMDEXECOPT .

pguidCmdGroup
Unikatowy identyfikator grupy poleceń. Domyślnie wartość NULL, która określa grupę standardową. Polecenie przekazane w identyfikatorze nCmdID musi należeć do grupy.

Wartość zwracana

Zwraca S_OK w przypadku powodzenia; w przeciwnym razie zwraca jeden z następujących kodów błędów.

Wartość Opis
E_UNEXPECTED Wystąpił nieoczekiwany błąd.
E_FAIL Błąd.
E_NOTIMPL Wskazuje, że sam MFC powinien próbować przetłumaczyć i wysłać polecenie.
OLECMDERR_E_UNKNOWNGROUP pguidCmdGroup nie ma wartości NULL, ale nie określa rozpoznanej grupy poleceń.
OLECMDERR_E_NOTSUPPORTED Identyfikator nCmdID nie jest rozpoznawany jako prawidłowe polecenie w grupie pGroup.
OLECMDERR_DISABLED Polecenie zidentyfikowane przez identyfikator nCmdID jest wyłączone i nie można go wykonać.
OLECMDERR_NOHELP Wywołujący poprosił o pomoc w poleceniu zidentyfikowanym przez nCmdID , ale żadna pomoc nie jest dostępna.
OLECMDERR_CANCELLED Użytkownik anulował wykonanie.

Uwagi

Parametry pguidCmdGroup i nCmdID razem jednoznacznie identyfikują polecenie do wywołania. Parametr nCmdExecOpt określa dokładną akcję do wykonania.

COleDocObjectItem::GetActiveView

Wywołaj tę funkcję składową, aby uzyskać wskaźnik do IOleDocumentView interfejsu aktualnie aktywnego widoku.

LPOLEDOCUMENTVIEW GetActiveView() const;

Wartość zwracana

Wskaźnik do interfejsu IOleDocumentView aktualnie aktywnego widoku. Jeśli nie ma bieżącego widoku, zwraca wartość NULL.

Uwagi

Liczba odwołań dla zwróconego IOleDocumentView wskaźnika nie jest zwiększana przed zwróceniem jej przez tę funkcję.

COleDocObjectItem::GetPageCount

Wywołaj tę funkcję składową, aby pobrać liczbę stron w dokumencie.

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parametry

pnFirstPage
Wskaźnik do liczby pierwszej strony dokumentu. Może mieć wartość NULL, co wskazuje, że obiekt wywołujący nie potrzebuje tego numeru.

pcPages
Wskaźnik do łącznej liczby stron w dokumencie. Może mieć wartość NULL, co wskazuje, że obiekt wywołujący nie potrzebuje tego numeru.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

COleDocObjectItem::OnPreparePrinting

Ta funkcja składowa jest wywoływana przez platformę w celu przygotowania dokumentu do drukowania.

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

Parametry

pCaller
Wskaźnik do obiektu CView , który wysyła polecenie drukowania.

Pinfo
Wskaźnik do obiektu CPrintInfo , który opisuje zadanie do wydrukowania.

bPrintAll
Określa, czy cały dokument ma zostać wydrukowany.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

COleDocObjectItem::OnPrint

Ta funkcja składowa jest wywoływana przez platformę w celu wydrukowania dokumentu.

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

Parametry

pCaller
Wskaźnik do obiektu CView, który wysyła polecenie drukowania.

Pinfo
Wskaźnik do obiektu CPrintInfo , który opisuje zadanie do wydrukowania.

bPrintAll
Określa, czy cały dokument ma zostać wydrukowany.

COleDocObjectItem::QueryCommand

Wykonuje zapytania dotyczące stanu co najmniej jednego polecenia wygenerowanego przez zdarzenia interfejsu użytkownika.

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

Parametry

nCmdID
identyfikator polecenia, dla którego jest wykonywane zapytanie.

pdwStatus
Wskaźnik do flag zwróconych w wyniku zapytania. Aby uzyskać listę możliwych wartości, zobacz OLECMDF.

pCmdText
Wskaźnik do struktury OLECMDTEXT , w której ma być zwracana nazwa i informacje o stanie dla pojedynczego polecenia. Może mieć wartość NULL, aby wskazać, że obiekt wywołujący nie potrzebuje tych informacji.

pguidCmdGroup
Unikatowy identyfikator grupy poleceń; może mieć wartość NULL, aby określić grupę standardową.

Wartość zwracana

Aby uzyskać pełną listę wartości zwracanych, zobacz IOleCommandTarget::QueryStatus w zestawie Windows SDK.

Uwagi

Ta funkcja składowa emuluje funkcjonalność metody IOleCommandTarget::QueryStatus zgodnie z opisem w zestawie WINDOWS SDK.

COleDocObjectItem::Release

Zwalnia połączenie z połączonym elementem OLE i zamyka je, jeśli został otwarty. Nie niszczy elementu klienta.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parametry

dwCloseOption
Flaga określająca, w jakich okolicznościach element OLE jest zapisywany po powrocie do stanu załadowanego. Aby uzyskać listę możliwych wartości, zobacz COleClientItem::Close.

Uwagi

Nie niszczy elementu klienta.

Zobacz też

Przykład MFCBIND
Klasa COleClientItem
Wykres hierarchii
Klasa COleClientItem
Klasa CDocObjectServerItem