Kelas COleDocObjectItem

Menerapkan penahanan dokumen Aktif.

Sintaks

class COleDocObjectItem : public COleClientItem

Anggota

Konstruktor Publik

Nama	Deskripsi
COleDocObjectItem::COleDocObjectItem	Membuat COleDocObject item.

Metode Publik

Nama	Deskripsi
COleDocObjectItem::D oDefaultPrinting	Mencetak dokumen aplikasi kontainer menggunakan pengaturan printer default.
COleDocObjectItem::ExecCommand	Menjalankan perintah yang ditentukan oleh pengguna.
COleDocObjectItem::GetActiveView	Mengambil tampilan aktif dokumen.
COleDocObjectItem::GetPageCount	Mengambil jumlah halaman dalam dokumen aplikasi kontainer.
COleDocObjectItem::OnPreparePrinting	Menyiapkan dokumen aplikasi kontainer untuk pencetakan.
COleDocObjectItem::OnPrint	Mencetak dokumen aplikasi kontainer.
COleDocObjectItem::QueryCommand	Kueri untuk status satu atau beberapa perintah yang dihasilkan oleh peristiwa antarmuka pengguna.
COleDocObjectItem::Release	Merilis koneksi ke item tertaut OLE dan menutupnya jika terbuka. Tidak menghancurkan item klien.

Keterangan

Di MFC, dokumen Aktif ditangani mirip dengan penyematan biasa yang dapat diedit di tempat, dengan perbedaan berikut:

• Kelas COleDocument-turunan masih mempertahankan daftar item yang saat ini disematkan; namun, item ini mungkin COleDocObjectItem-turunan item.

• Saat dokumen aktif aktif, dokumen tersebut menempati seluruh area klien tampilan saat aktif di tempat.

• Kontainer dokumen Aktif memiliki kontrol penuh atas menu Bantuan .

• Menu Bantuan berisi item menu untuk kontainer dokumen aktif dan server.

Karena kontainer Dokumen aktif memiliki menu Bantuan, kontainer bertanggung jawab untuk meneruskan pesan menu Bantuan server ke server. Integrasi ini ditangani oleh COleDocObjectItem.

Untuk informasi selengkapnya tentang penggabungan menu dan Aktivasi dokumen aktif, lihat Gambaran Umum Penahanan Dokumen Aktif.

Hierarki Warisan

CObject

CCmdTarget

CDocItem

COleClientItem

COleDocObjectItem

Persyaratan

Header: afxole.h

COleDocObjectItem::COleDocObjectItem

Panggil fungsi anggota ini untuk menginisialisasi COleDocObjectItem objek.

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parameter

pContainerDoc
Penunjuk ke objek yang COleDocument bertindak sebagai kontainer dokumen aktif. Parameter ini harus NULL untuk mengaktifkan IMPLEMENT_SERIALIZE. Biasanya item OLE dibangun dengan penunjuk dokumen non-NULL.

COleDocObjectItem::D oDefaultPrinting

Dipanggil oleh kerangka kerja ke dokumen menggunakan pengaturan default.

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

Parameter

pCaller
Penunjuk ke objek CView yang mengirim perintah cetak.

pInfo
Penunjuk ke objek CPrintInfo yang menjelaskan pekerjaan yang akan dicetak.

COleDocObjectItem::ExecCommand

Panggil fungsi anggota ini untuk menjalankan perintah yang ditentukan oleh pengguna.

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

Parameter

nCmdID
Pengidentifikasi perintah yang akan dijalankan. Harus berada dalam grup yang diidentifikasi oleh pguidCmdGroup.

nCmdExecOpt
Menentukan opsi eksekusi perintah. Secara default, atur untuk menjalankan perintah tanpa meminta pengguna. Lihat OLECMDEXECOPT untuk daftar nilai.

pguidCmdGroup
Pengidentifikasi unik grup perintah. Secara default, NULL, yang menentukan grup standar. Perintah yang diteruskan dalam nCmdID harus termasuk dalam grup.

Tampilkan Nilai

Mengembalikan S_OK jika berhasil; jika tidak, mengembalikan salah satu kode kesalahan berikut.

Nilai	Deskripsi
E_UNEXPECTED	Terjadi kesalahan yang tidak terduga.
E_FAIL	Terjadi kesalahan.
E_NOTIMPL	Menunjukkan MFC sendiri harus mencoba menerjemahkan dan mengirimkan perintah.
OLECMDERR_E_UNKNOWNGROUP	pguidCmdGroup bukan- NULL tetapi tidak menentukan grup perintah yang dikenali.
OLECMDERR_E_NOTSUPPORTED	nCmdID tidak dikenali sebagai perintah yang valid dalam grup pGroup.
OLECMDERR_DISABLED	Perintah yang diidentifikasi oleh nCmdID dinonaktifkan dan tidak dapat dijalankan.
OLECMDERR_NOHELP	Penelepon meminta bantuan pada perintah yang diidentifikasi oleh nCmdID tetapi tidak ada bantuan yang tersedia.
OLECMDERR_CANCELLED	Pengguna membatalkan eksekusi.

Keterangan

Parameter pguidCmdGroup dan nCmdID bersama-sama secara unik mengidentifikasi perintah yang akan dipanggil. Parameter nCmdExecOpt menentukan tindakan yang tepat untuk diambil.

COleDocObjectItem::GetActiveView

Panggil fungsi anggota ini untuk mendapatkan penunjuk ke IOleDocumentView antarmuka tampilan yang saat ini aktif.

LPOLEDOCUMENTVIEW GetActiveView() const;

Tampilkan Nilai

Penunjuk ke antarmuka IOleDocumentView dari tampilan yang saat ini aktif. Jika tidak ada tampilan saat ini, tampilan akan mengembalikan NULL.

Keterangan

Jumlah referensi pada penunjuk yang dikembalikan IOleDocumentView tidak bertambah sebelum dikembalikan oleh fungsi ini.

COleDocObjectItem::GetPageCount

Panggil fungsi anggota ini untuk mengambil jumlah halaman dalam dokumen.

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parameter

pnFirstPage
Penunjuk ke jumlah halaman pertama dokumen. Bisa NULL, yang menunjukkan pemanggil tidak memerlukan nomor ini.

pcPages
Penunjuk ke jumlah total halaman dalam dokumen. Bisa NULL, yang menunjukkan pemanggil tidak memerlukan nomor ini.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

COleDocObjectItem::OnPreparePrinting

Fungsi anggota ini dipanggil oleh kerangka kerja untuk menyiapkan dokumen untuk pencetakan.

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

Parameter

pCaller
Penunjuk ke objek CView yang mengirim perintah cetak.

pInfo
Penunjuk ke objek CPrintInfo yang menjelaskan pekerjaan yang akan dicetak.

bPrintAll
Menentukan apakah seluruh dokumen akan dicetak.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

COleDocObjectItem::OnPrint

Fungsi anggota ini dipanggil oleh kerangka kerja untuk mencetak dokumen.

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

Parameter

pCaller
Penunjuk ke objek CView yang mengirim perintah cetak.

pInfo
Penunjuk ke objek CPrintInfo yang menjelaskan pekerjaan yang akan dicetak.

bPrintAll
Menentukan apakah seluruh dokumen akan dicetak.

COleDocObjectItem::QueryCommand

Kueri untuk status satu atau beberapa perintah yang dihasilkan oleh peristiwa antarmuka pengguna.

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

Parameter

nCmdID
pengidentifikasi perintah yang sedang dikueri.

pdwStatus
Penunjuk ke bendera yang dikembalikan sebagai hasil dari kueri. Untuk daftar nilai yang mungkin, lihat OLECMDF.

pCmdText
Penunjuk ke struktur OLECMDTEXT untuk mengembalikan informasi nama dan status untuk satu perintah. Dapat berupa NULL untuk menunjukkan bahwa pemanggil tidak memerlukan informasi ini.

pguidCmdGroup
Pengidentifikasi unik grup perintah; dapat berupa NULL untuk menentukan grup standar.

Tampilkan Nilai

Untuk daftar lengkap nilai pengembalian, lihat IOleCommandTarget::QueryStatus di Windows SDK.

Keterangan

Fungsi anggota ini meniru fungsionalitas metode IOleCommandTarget::QueryStatus , seperti yang dijelaskan di Windows SDK.

COleDocObjectItem::Release

Merilis koneksi ke item tertaut OLE dan menutupnya jika terbuka. Tidak menghancurkan item klien.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parameter

dwCloseOption
Bendera yang menentukan dalam keadaan apa item OLE disimpan saat kembali ke status dimuat. Untuk daftar nilai yang mungkin, lihat COleClientItem::Close.

Keterangan

Tidak menghancurkan item klien.

Lihat juga

MFC Sampel MFCBIND
Kelas COleClientItem
Bagan Hierarki
Kelas COleClientItem
Kelas CDocObjectServerItem