Bagikan melalui

Kelas COleClientItem

  • Artikel

Menentukan antarmuka kontainer ke item OLE.

Sintaks

class COleClientItem : public CDocItem

Anggota

Konstruktor Publik

Nama Deskripsi
COleClientItem::COleClientItem Membuat COleClientItem objek.

Metode Publik

Nama Deskripsi
COleClientItem::Activate Membuka item OLE untuk operasi lalu menjalankan kata kerja yang ditentukan.
COleClientItem::ActivateAs Mengaktifkan item sebagai tipe lain.
COleClientItem::AttachDataObject Mengakses data di objek OLE.
COleClientItem::CanCreateFromData Menunjukkan apakah aplikasi kontainer dapat membuat objek yang disematkan.
COleClientItem::CanCreateLinkFromData Menunjukkan apakah aplikasi kontainer dapat membuat objek tertaut.
COleClientItem::CanPaste Menunjukkan apakah Clipboard berisi item OLE yang dapat disematkan atau statis.
COleClientItem::CanPasteLink Menunjukkan apakah Clipboard berisi item OLE yang dapat ditautkan.
COleClientItem::Close Menutup tautan ke server tetapi tidak menghancurkan item OLE.
COleClientItem::ConvertTo Mengonversi item ke tipe lain.
COleClientItem::CopyToClipboard Menyalin item OLE ke Clipboard.
COleClientItem::CreateCloneFrom Membuat duplikat item yang sudah ada.
COleClientItem::CreateFromClipboard Membuat item yang disematkan dari Clipboard.
COleClientItem::CreateFromData Membuat item yang disematkan dari objek data.
COleClientItem::CreateFromFile Membuat item yang disematkan dari file.
COleClientItem::CreateLinkFromClipboard Membuat item tertaut dari Clipboard.
COleClientItem::CreateLinkFromData Membuat item tertaut dari objek data.
COleClientItem::CreateLinkFromFile Membuat item tertaut dari file.
COleClientItem::CreateNewItem Membuat item tersemat baru dengan meluncurkan aplikasi server.
COleClientItem::CreateStaticFromClipboard Membuat item statis dari Clipboard.
COleClientItem::CreateStaticFromData Membuat item statis dari objek data.
COleClientItem::D aktivasi Menonaktifkan item.
COleClientItem::D eactivateUI Memulihkan antarmuka pengguna aplikasi kontainer ke status aslinya.
COleClientItem::D elete Menghapus atau menutup item OLE jika item tersebut adalah item tertaut.
COleClientItem::D oDragDrop Melakukan operasi seret dan letakkan.
COleClientItem::D oVerb Menjalankan kata kerja yang ditentukan.
COleClientItem::D raw Menggambar item OLE.
COleClientItem::GetActiveView Mendapatkan tampilan tempat item diaktifkan.
COleClientItem::GetCachedExtent Mengembalikan batas persegi panjang item OLE.
COleClientItem::GetClassID Mendapatkan ID kelas item saat ini.
COleClientItem::GetClipboardData Mendapatkan data yang akan ditempatkan di Clipboard dengan memanggil CopyToClipboard fungsi anggota.
COleClientItem::GetDocument Mengembalikan COleDocument objek yang berisi item saat ini.
COleClientItem::GetDrawAspect Mendapatkan tampilan item saat ini untuk penyajian.
COleClientItem::GetExtent Mengembalikan batas persegi panjang item OLE.
COleClientItem::GetIconFromRegistry Mengambil handel ke ikon yang terkait dengan server CLSID tertentu.
COleClientItem::GetIconicMetafile Mendapatkan metafile yang digunakan untuk menggambar ikon item.
COleClientItem::GetInPlaceWindow Mengembalikan penunjuk ke jendela pengeditan item di tempat.
COleClientItem::GetItemState Mendapatkan status item saat ini.
COleClientItem::GetLastStatus Mengembalikan status operasi OLE terakhir.
COleClientItem::GetLinkUpdateOptions Mengembalikan mode pembaruan untuk item tertaut (fitur tingkat lanjut).
COleClientItem::GetType Mengembalikan tipe (disematkan, ditautkan, atau statis) dari item OLE.
COleClientItem::GetUserType Mendapatkan string yang menjelaskan jenis item.
COleClientItem::IsInPlaceActive Mengembalikan TRUE jika item aktif di tempat.
COleClientItem::IsLinkUpToDate Mengembalikan TRUE jika item tertaut sudah diperbarui dengan dokumen sumbernya.
COleClientItem::IsModified Mengembalikan TRUE jika item telah dimodifikasi sejak terakhir disimpan.
COleClientItem::IsOpen Mengembalikan TRUE jika item saat ini terbuka di aplikasi server.
COleClientItem::IsRunning Mengembalikan TRUE jika aplikasi server item sedang berjalan.
COleClientItem::OnActivate Dipanggil oleh kerangka kerja untuk memberi tahu item bahwa item diaktifkan.
COleClientItem::OnActivateUI Dipanggil oleh kerangka kerja untuk memberi tahu item bahwa item diaktifkan dan harus menampilkan antarmuka penggunanya.
COleClientItem::OnChange Dipanggil ketika server mengubah item OLE. Implementasi diperlukan.
COleClientItem::OnDeactivate Dipanggil oleh kerangka kerja saat item dinonaktifkan.
COleClientItem::OnDeactivateUI Dipanggil oleh kerangka kerja ketika server telah menghapus antarmuka pengguna di tempatnya.
COleClientItem::OnGetClipboardData Dipanggil oleh kerangka kerja untuk mendapatkan data yang akan disalin ke Clipboard.
COleClientItem::OnInsertMenus Dipanggil oleh kerangka kerja untuk membuat menu komposit.
COleClientItem::OnRemoveMenus Dipanggil oleh kerangka kerja untuk menghapus menu kontainer dari menu komposit.
COleClientItem::OnSetMenu Dipanggil oleh kerangka kerja untuk menginstal dan menghapus menu komposit.
COleClientItem::OnShowControlBars Dipanggil oleh kerangka kerja untuk menampilkan dan menyembunyikan bilah kontrol.
COleClientItem::OnUpdateFrameTitle Dipanggil oleh kerangka kerja untuk memperbarui bilah judul jendela bingkai.
COleClientItem::ReactivateAndUndo Mengaktifkan kembali item dan membatalkan operasi pengeditan di tempat terakhir.
COleClientItem::Release Merilis koneksi ke item tertaut OLE dan menutupnya jika terbuka. Tidak menghancurkan item klien.
COleClientItem::Reload Memuat ulang item setelah panggilan ke ActivateAs.
COleClientItem::Run Menjalankan aplikasi yang terkait dengan item.
COleClientItem::SetDrawAspect Mengatur tampilan item saat ini untuk penyajian.
COleClientItem::SetExtent Mengatur persegi panjang pembatas item OLE.
COleClientItem::SetHostNames Mengatur nama yang ditampilkan server saat mengedit item OLE.
COleClientItem::SetIconicMetafile Cache metafile yang digunakan untuk menggambar ikon item.
COleClientItem::SetItemRects Mengatur persegi panjang pembatas item.
COleClientItem::SetLinkUpdateOptions Mengatur mode pembaruan untuk item tertaut (fitur tingkat lanjut).
COleClientItem::SetPrintDevice Menyetel perangkat target cetak untuk item klien ini.
COleClientItem::UpdateLink Memperbarui singgahan presentasi item.

Metode yang Dilindungi

Nama Deskripsi
COleClientItem::CanActivate Dipanggil oleh kerangka kerja untuk menentukan apakah aktivasi di tempat diizinkan.
COleClientItem::OnChangeItemPosition Dipanggil oleh kerangka kerja saat posisi item berubah.
COleClientItem::OnDeactivateAndUndo Dipanggil oleh kerangka kerja untuk membatalkan setelah aktivasi.
COleClientItem::OnDiscardUndoState Dipanggil oleh kerangka kerja untuk membuang informasi status batalkan item.
COleClientItem::OnGetClipRect Dipanggil oleh kerangka kerja untuk mendapatkan koordinat kliping-persegi panjang item.
COleClientItem::OnGetItemPosition Dipanggil oleh kerangka kerja untuk mendapatkan posisi item relatif terhadap tampilan.
COleClientItem::OnGetWindowContext Dipanggil oleh kerangka kerja saat item diaktifkan di tempat.
COleClientItem::OnScrollBy Dipanggil oleh kerangka kerja untuk menggulir item ke dalam tampilan.
COleClientItem::OnShowItem Dipanggil oleh kerangka kerja untuk menampilkan item OLE.

Keterangan

Item OLE mewakili data, dibuat dan dikelola oleh aplikasi server, yang dapat dimasukkan dengan "mulus" ke dalam dokumen sehingga tampaknya pengguna menjadi satu dokumen. Hasilnya adalah "dokumen majemuk" yang terdiri dari item OLE dan dokumen yang berisi.

Item OLE dapat disematkan atau ditautkan. Jika disematkan, datanya disimpan sebagai bagian dari dokumen majemuk. Jika ditautkan, datanya disimpan sebagai bagian dari file terpisah yang dibuat oleh aplikasi server, dan hanya tautan ke file tersebut yang disimpan dalam dokumen gabungan. Semua item OLE berisi informasi yang menentukan aplikasi server yang harus dipanggil untuk mengeditnya.

COleClientItem mendefinisikan beberapa fungsi yang dapat diambil alih yang dipanggil sebagai respons terhadap permintaan dari aplikasi server; overridable ini biasanya bertindak sebagai pemberitahuan. Ini memungkinkan aplikasi server untuk menginformasikan kontainer perubahan yang dilakukan pengguna saat mengedit item OLE, atau untuk mengambil informasi yang diperlukan selama pengeditan.

COleClientItem dapat digunakan dengan kelas COleDocument, COleLinkingDoc, atau COleServerDoc . Untuk menggunakan COleClientItem, dapatkan kelas darinya dan terapkan fungsi anggota OnChange , yang menentukan bagaimana kontainer merespons perubahan yang dibuat pada item. Untuk mendukung aktivasi di tempat, ambil alih fungsi anggota OnGetItemPosition . Fungsi ini menyediakan informasi tentang posisi item OLE yang ditampilkan.

Untuk informasi selengkapnya tentang menggunakan antarmuka kontainer, lihat artikel Kontainer: Menerapkan Kontainer dan Aktivasi.

Catatan

Windows SDK mengacu pada item yang disematkan dan ditautkan sebagai "objek" dan menyebut jenis item sebagai "kelas." Referensi ini menggunakan istilah "item" untuk membedakan entitas OLE dari objek C++ yang sesuai dan istilah "jenis" untuk membedakan kategori OLE dari kelas C++.

Hierarki Warisan

CObject

CCmdTarget

CDocItem

COleClientItem

Persyaratan

Header: afxole.h

COleClientItem::Activate

Panggil fungsi ini untuk menjalankan kata kerja yang ditentukan alih-alih DoVerb sehingga Anda dapat melakukan pemrosesan Anda sendiri saat pengecualian dilemparkan.

void Activate(
    LONG nVerb,
    CView* pView,
    LPMSG lpMsg = NULL);

Parameter

nVerb
Menentukan kata kerja yang akan dijalankan. Bisa jadi salah satu dari yang berikut:

Nilai Makna Simbol
0- Kata kerja utama OLEIVERB_PRIMARY
-1 Kata kerja sekunder (Tidak Ada)
-1 Tampilkan item untuk pengeditan OLEIVERB_SHOW
-2 Edit item di jendela terpisah OLEIVERB_OPEN
-3 Sembunyikan item OLEIVERB_HIDE

Nilai -1 biasanya merupakan alias untuk kata kerja lain. Jika pengeditan terbuka tidak didukung, -2 memiliki efek yang sama dengan -1. Untuk nilai tambahan, lihat IOleObject::D oVerb di Windows SDK.

pView
Penunjuk ke jendela tampilan kontainer yang berisi item OLE; ini digunakan oleh aplikasi server untuk aktivasi di tempat. Parameter ini harus NULL jika kontainer tidak mendukung aktivasi di tempat.

lpMsg
Penunjuk ke pesan yang menyebabkan item diaktifkan.

Keterangan

Jika aplikasi server ditulis menggunakan Pustaka Kelas Microsoft Foundation, fungsi ini menyebabkan fungsi anggota OnDoVerb dari objek yang COleServerItem sesuai dijalankan.

Jika kata kerja utama adalah Edit dan nol ditentukan dalam parameter nVerb , aplikasi server diluncurkan untuk memungkinkan item OLE diedit. Jika aplikasi kontainer mendukung aktivasi di tempat, pengeditan dapat dilakukan di tempat. Jika kontainer tidak mendukung aktivasi di tempat (atau jika kata kerja Buka ditentukan), server diluncurkan di jendela terpisah dan pengeditan dapat dilakukan di sana. Biasanya, ketika pengguna aplikasi kontainer mengklik dua kali item OLE, nilai untuk kata kerja utama dalam parameter nVerb menentukan tindakan mana yang dapat diambil pengguna. Namun, jika server hanya mendukung satu tindakan, ia mengambil tindakan tersebut, tidak peduli nilai mana yang ditentukan dalam parameter nVerb .

Untuk informasi selengkapnya, lihat IOleObject::D oVerb di Windows SDK.

COleClientItem::ActivateAs

Menggunakan fasilitas konversi objek OLE untuk mengaktifkan item seolah-olah itu adalah item dari jenis yang ditentukan oleh clsidNew.

virtual BOOL ActivateAs(
    LPCTSTR lpszUserType,
    REFCLSID clsidOld,
    REFCLSID clsidNew);

Parameter

lpszUserType
Penunjuk ke string yang mewakili jenis pengguna target, seperti "Dokumen Word."

clsidOld
Referensi ke ID kelas item saat ini. ID kelas harus mewakili jenis objek aktual, seperti yang disimpan, kecuali itu adalah tautan. Dalam hal ini, seharusnya CLSID item yang dirujuk tautan. COleConvertDialog secara otomatis menyediakan ID kelas yang benar untuk item tersebut.

clsidNew
Referensi ke ID kelas target.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Ini dipanggil secara otomatis oleh COleConvertDialog::D oConvert. Biasanya tidak dipanggil secara langsung.

COleClientItem::AttachDataObject

Panggil fungsi ini untuk menginisialisasi COleDataObject untuk mengakses data dalam item OLE.

void AttachDataObject(COleDataObject& rDataObject) const;

Parameter

rDataObject
Referensi ke COleDataObject objek yang akan diinisialisasi untuk mengizinkan akses ke data dalam item OLE.

COleClientItem::CanActivate

Dipanggil oleh kerangka kerja ketika pengguna meminta aktivasi item OLE di tempat; nilai pengembalian fungsi ini menentukan apakah aktivasi di tempat diizinkan.

virtual BOOL CanActivate();

Tampilkan Nilai

Nonzero jika aktivasi di tempat diizinkan; jika tidak, 0.

Keterangan

Implementasi default memungkinkan aktivasi di tempat jika kontainer memiliki jendela yang valid. Ambil alih fungsi ini untuk menerapkan logika khusus untuk menerima atau menolak permintaan aktivasi. Misalnya, permintaan aktivasi dapat ditolak jika item OLE terlalu kecil atau saat ini tidak terlihat.

Untuk informasi selengkapnya, lihat IOleInPlaceSite::CanInPlaceActivate di Windows SDK.

COleClientItem::CanCreateFromData

Memeriksa apakah aplikasi kontainer dapat membuat objek yang disematkan dari objek yang diberikan COleDataObject .

static BOOL PASCAL CanCreateFromData(const COleDataObject* pDataObject);

Parameter

pDataObject
Penunjuk ke objek COleDataObject tempat item OLE akan dibuat.

Tampilkan Nilai

Bukan nol jika kontainer dapat membuat objek yang disematkan dari COleDataObject objek; jika tidak, 0.

Keterangan

Kelas COleDataObject digunakan dalam transfer data untuk mengambil data dalam berbagai format dari Clipboard, melalui seret dan letakkan, atau dari item OLE yang disematkan.

Kontainer dapat menggunakan fungsi ini untuk memutuskan untuk mengaktifkan atau menonaktifkan perintah Edit Tempel dan Edit Tempel Khusus.

Untuk informasi selengkapnya, lihat artikel Objek Data dan Sumber Data (OLE).

COleClientItem::CanCreateLinkFromData

Memeriksa apakah aplikasi kontainer dapat membuat objek tertaut dari objek yang diberikan COleDataObject .

static BOOL PASCAL CanCreateLinkFromData(const COleDataObject* pDataObject);

Parameter

pDataObject
Penunjuk ke objek COleDataObject tempat item OLE akan dibuat.

Tampilkan Nilai

Bukan nol jika kontainer dapat membuat objek tertaut dari COleDataObject objek.

Keterangan

Kelas COleDataObject digunakan dalam transfer data untuk mengambil data dalam berbagai format dari Clipboard, melalui seret dan letakkan, atau dari item OLE yang disematkan.

Kontainer dapat menggunakan fungsi ini untuk memutuskan untuk mengaktifkan atau menonaktifkan perintah Edit Tempel Khusus dan Edit Tautan Tempel.

Untuk informasi selengkapnya, lihat artikel Objek Data dan Sumber Data (OLE).

COleClientItem::CanPaste

Panggil fungsi ini untuk melihat apakah item OLE yang disematkan dapat ditempelkan dari Clipboard.

static BOOL PASCAL CanPaste();

Tampilkan Nilai

Bukan nol jika item OLE yang disematkan dapat ditempelkan dari Clipboard; jika tidak, 0.

Keterangan

Untuk informasi selengkapnya, lihat OleGetClipboard dan OleQueryCreateFromData di Windows SDK.

Panggil fungsi ini untuk melihat apakah item OLE tertaut dapat ditempelkan dari Clipboard.

static BOOL PASCAL CanPasteLink();

Tampilkan Nilai

Bukan nol jika item OLE yang ditautkan dapat ditempelkan dari Clipboard; jika tidak, 0.

Keterangan

Untuk informasi selengkapnya, lihat OleGetClipboard dan OleQueryLinkFromData di Windows SDK.

COleClientItem::Close

Panggil fungsi ini untuk mengubah status item OLE dari status berjalan ke status dimuat, yaitu, dimuat dengan handler-nya dalam memori tetapi dengan server tidak berjalan.

void Close(OLECLOSE dwCloseOption = OLECLOSE_SAVEIFDIRTY);

Parameter

dwCloseOption
Bendera yang menentukan dalam keadaan apa item OLE disimpan saat kembali ke status dimuat. Ini dapat memiliki salah satu nilai berikut:

  • OLECLOSE_SAVEIFDIRTY Simpan item OLE.

  • OLECLOSE_NOSAVE Jangan simpan item OLE.

  • OLECLOSE_PROMPTSAVE Meminta pengguna tentang apakah akan menyimpan item OLE.

Keterangan

Fungsi ini tidak berpengaruh ketika item OLE tidak berjalan.

Untuk informasi selengkapnya, lihat IOleObject::Close di Windows SDK.

COleClientItem::COleClientItem

Membuat COleClientItem objek dan menambahkannya ke kumpulan item dokumen dokumen kontainer, yang hanya membuat objek C++ dan tidak melakukan inisialisasi OLE apa pun.

COleClientItem(COleDocument* pContainerDoc = NULL);

Parameter

pContainerDoc
Penunjuk ke dokumen kontainer yang akan berisi item ini. Ini bisa menjadi turunan COleDocument apa pun.

Keterangan

Jika Anda meneruskan penunjuk NULL, tidak ada penambahan yang dilakukan ke dokumen kontainer. Anda harus secara eksplisit memanggil COleDocument::AddItem.

Anda harus memanggil salah satu fungsi anggota pembuatan berikut sebelum anda menggunakan item OLE:

COleClientItem::ConvertTo

Panggil fungsi anggota ini untuk mengonversi item ke jenis yang ditentukan oleh clsidNew.

virtual BOOL ConvertTo(REFCLSID clsidNew);

Parameter

clsidNew
ID kelas dari jenis target.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Ini dipanggil secara otomatis oleh COleConvertDialog. Tidak perlu menyebutnya secara langsung.

COleClientItem::CopyToClipboard

Panggil fungsi ini untuk menyalin item OLE ke Clipboard.

void CopyToClipboard(BOOL bIncludeLink = FALSE);

Parameter

bIncludeLink
TRUE jika informasi tautan harus disalin ke Clipboard, memungkinkan item tertaut ditempelkan; jika tidak FALSE.

Keterangan

Biasanya, Anda memanggil fungsi ini saat menulis handler pesan untuk perintah Salin atau Potong dari menu Edit. Anda harus menerapkan pilihan item di aplikasi kontainer Jika Anda ingin menerapkan perintah Salin atau Potong.

Untuk informasi selengkapnya, lihat OleSetClipboard di Windows SDK.

COleClientItem::CreateCloneFrom

Panggil fungsi ini untuk membuat salinan item OLE yang ditentukan.

BOOL CreateCloneFrom(const COleClientItem* pSrcItem);

Parameter

pSrcItem
Arahkan ke item OLE yang akan diduplikasi.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Salinan identik dengan item sumber. Anda dapat menggunakan fungsi ini untuk mendukung operasi batalkan.

COleClientItem::CreateFromClipboard

Panggil fungsi ini untuk membuat item yang disematkan dari konten Clipboard.

BOOL CreateFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Anda biasanya memanggil fungsi ini dari handler pesan untuk perintah Tempel pada menu Edit. (Perintah Tempel diaktifkan oleh kerangka kerja jika Fungsi anggota CanPaste mengembalikan nonzero.)

Untuk informasi selengkapnya, lihat OLERENDER dan FORMATETC di Windows SDK.

COleClientItem::CreateFromData

Panggil fungsi ini untuk membuat item yang disematkan dari COleDataObject objek.

BOOL CreateFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Penunjuk ke objek COleDataObject tempat item OLE akan dibuat.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Operasi transfer data, seperti menempelkan dari operasi Clipboard atau seret dan letakkan, menyediakan COleDataObject objek yang berisi informasi yang ditawarkan oleh aplikasi server. Biasanya digunakan dalam penimpaan CView::OnDrop Anda.

Untuk informasi selengkapnya, lihat OleCreateFromData, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::CreateFromFile

Panggil fungsi ini untuk membuat item OLE yang disematkan dari file.

BOOL CreateFromFile(
    LPCTSTR lpszFileName,
    REFCLSID clsid = CLSID_NULL,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

lpszFileName
Penunjuk ke nama file tempat item OLE akan dibuat.

clsid
Disiapkan untuk penggunaan masa mendatang.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Kerangka kerja memanggil fungsi ini dari COleInsertDialog::CreateItem jika pengguna memilih OK dari kotak dialog Sisipkan Objek saat tombol Buat dari File dipilih.

Untuk informasi selengkapnya, lihat OleCreateFromFile, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::CreateLinkFromClipboard

Panggil fungsi ini untuk membuat item tertaut dari konten Clipboard.

BOOL CreateLinkFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Anda biasanya memanggil fungsi ini dari handler pesan untuk perintah Tempel Tautan pada menu Edit. (Perintah Tempel Tautan diaktifkan dalam implementasi defaultCOleDocument jika Clipboard berisi item OLE yang dapat ditautkan.)

Untuk informasi selengkapnya, lihat OLERENDER dan FORMATETC di Windows SDK.

COleClientItem::CreateLinkFromData

Panggil fungsi ini untuk membuat item tertaut dari COleDataObject objek.

BOOL CreateLinkFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Penunjuk ke objek COleDataObject tempat item OLE akan dibuat.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Panggil ini selama operasi penghilangan saat pengguna menunjukkan tautan harus dibuat. Ini juga dapat digunakan untuk menangani perintah Edit Tempel. Ini dipanggil oleh kerangka kerja di COleClientItem::CreateLinkFromClipboard dan di COlePasteSpecialDialog::CreateItem ketika opsi Tautan telah dipilih.

Untuk informasi selengkapnya, lihat OleCreateLinkFromData, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::CreateLinkFromFile

Panggil fungsi ini untuk membuat item OLE tertaut dari file.

BOOL CreateLinkFromFile(
    LPCTSTR lpszFileName,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

lpszFileName
Penunjuk ke nama file tempat item OLE akan dibuat.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Kerangka kerja memanggil fungsi ini jika pengguna memilih OK dari kotak dialog Sisipkan Objek saat tombol Buat dari File dipilih dan kotak centang Tautan dicentang. Ini dipanggil dari COleInsertDialog::CreateItem.

Untuk informasi selengkapnya, lihat OleCreateLinkToFile, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::CreateNewItem

Panggil fungsi ini untuk membuat item yang disematkan; fungsi ini meluncurkan aplikasi server yang memungkinkan pengguna untuk membuat item OLE.

BOOL CreateNewItem(
    REFCLSID clsid,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

clsid
ID yang secara unik mengidentifikasi jenis item OLE yang akan dibuat.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Kerangka kerja memanggil fungsi ini jika pengguna memilih OK dari kotak dialog Sisipkan Objek saat tombol Buat Baru dipilih.

Untuk informasi selengkapnya, lihat OleCreate, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::CreateStaticFromClipboard

Panggil fungsi ini untuk membuat item statis dari konten Clipboard.

BOOL CreateStaticFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Item statis berisi data presentasi tetapi bukan data asli; akibatnya tidak dapat diedit. Anda biasanya memanggil fungsi ini jika fungsi anggota CreateFromClipboard gagal.

Untuk informasi selengkapnya, lihat OLERENDER dan FORMATETC di Windows SDK.

COleClientItem::CreateStaticFromData

Panggil fungsi ini untuk membuat item statis dari COleDataObject objek.

BOOL CreateStaticFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Penunjuk ke objek COleDataObject tempat item OLE akan dibuat.

Membuat
Bendera yang menentukan bagaimana server akan merender item OLE. Untuk nilai yang mungkin, lihat OLERENDER di Windows SDK.

cfFormat
Menentukan format data Clipboard yang akan di-cache saat membuat item OLE.

lpFormatEtc
Penunjuk ke struktur FORMATETC yang digunakan jika render OLERENDER_FORMAT atau OLERENDER_DRAW. Berikan nilai untuk parameter ini hanya jika Anda ingin menentukan informasi format tambahan di luar format Clipboard yang ditentukan oleh cfFormat. Jika Anda menghilangkan parameter ini, nilai default digunakan untuk bidang lain dalam FORMATETC struktur.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Item statis berisi data presentasi tetapi bukan data asli; akibatnya, itu tidak dapat diedit. Ini pada dasarnya sama dengan CreateStaticFromClipboard kecuali bahwa item statis dapat dibuat dari arbitrer COleDataObject, bukan hanya dari Clipboard.

Digunakan dalam COlePasteSpecialDialog::CreateItem saat Statis dipilih.

Untuk informasi selengkapnya, lihat OleCreateStaticFromData, OLERENDER, dan FORMATETC di Windows SDK.

COleClientItem::D aktivasi

Panggil fungsi ini untuk menonaktifkan item OLE dan membebaskan sumber daya terkait.

void Deactivate();

Keterangan

Anda biasanya menonaktifkan item OLE aktif di tempat saat pengguna mengklik mouse pada area klien di luar batas item. Perhatikan bahwa menonaktifkan item OLE akan membuang status batalkan, sehingga tidak mungkin untuk memanggil fungsi anggota ReactivateAndUndo .

Jika aplikasi Anda mendukung urungkan, jangan panggil Deactivate; sebagai gantinya, panggil NonaktifkanUI.

Untuk informasi selengkapnya, lihat IOleInPlaceObject::InPlaceDeactivate di Windows SDK.

COleClientItem::D eactivateUI

Panggil fungsi ini saat pengguna menonaktifkan item yang diaktifkan di tempat.

void DeactivateUI();

Keterangan

Fungsi ini memulihkan antarmuka pengguna aplikasi kontainer ke status aslinya, menyembunyikan menu apa pun dan kontrol lain yang dibuat untuk aktivasi di tempat.

Fungsi ini tidak menghapus informasi status batalkan untuk item. Informasi tersebut dipertahankan sehingga ReactivateAndUndo nantinya dapat digunakan untuk menjalankan perintah batalkan di aplikasi server, jika perintah batalkan kontainer dipilih segera setelah menonaktifkan item.

Untuk informasi selengkapnya, lihat IOleInPlaceObject::InPlaceDeactivate di Windows SDK.

COleClientItem::D elete

Panggil fungsi ini untuk menghapus item OLE dari dokumen kontainer.

void Delete(BOOL bAutoDelete = TRUE);

Parameter

bAutoDelete
Menentukan apakah item akan dihapus dari dokumen.

Keterangan

Fungsi ini memanggil fungsi Anggota rilis, yang pada gilirannya menghapus objek C++ untuk item, menghapus item OLE secara permanen dari dokumen. Jika item OLE disematkan, data asli untuk item akan dihapus. Selalu menutup server yang sedang berjalan; oleh karena itu, jika item adalah tautan terbuka, fungsi ini menutupnya.

COleClientItem::D oDragDrop

DoDragDrop Panggil fungsi anggota untuk melakukan operasi seret dan letakkan.

DROPEFFECT DoDragDrop(
    LPCRECT lpItemRect,
    CPoint ptOffset,
    BOOL bIncludeLink = FALSE,
    DWORD dwEffects = DROPEFFECT_COPY | DROPEFFECT_MOVE,
    LPCRECT lpRectStartDrag = NULL);

Parameter

lpItemRect
Persegi panjang item pada layar dalam koordinat klien (piksel).

ptOffset
Offset dari lpItemRect tempat posisi mouse berada pada saat seret.

bIncludeLink
Atur ini ke TRUE jika data tautan harus disalin ke Clipboard. Atur ke FALSE jika aplikasi server Anda tidak mendukung tautan.

dwEffects
Menentukan efek yang akan diizinkan sumber seret dalam operasi seret.

lpRectStartDrag
Penunjuk ke persegi panjang yang menentukan di mana seret benar-benar dimulai. Untuk informasi selengkapnya, lihat bagian Komentar berikut ini.

Tampilkan Nilai

Nilai DROPEFFECT. Jika DROPEFFECT_MOVE, data asli harus dihapus.

Keterangan

Operasi seret dan letakkan tidak segera dimulai. Ini menunggu sampai kursor mouse meninggalkan persegi panjang yang ditentukan oleh lpRectStartDrag atau sampai jumlah milidetik yang ditentukan telah berlalu. Jika lpRectStartDrag adalah NULL, ukuran persegi panjang adalah satu piksel.

Waktu penundaan ditentukan oleh pengaturan kunci registri. Anda dapat mengubah waktu penundaan dengan memanggil CWinApp::WriteProfileString atau CWinApp::WriteProfileInt. Jika Anda tidak menentukan waktu penundaan, nilai default 200 milidetik akan digunakan. Waktu penundaan seret disimpan sebagai berikut:

  • Waktu penundaan Seret Windows NT disimpan di HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\NT\CurrentVersion\IniFileMapping\win.ini\Windows\DragDelay.

  • Waktu penundaan Seret Windows 3.x disimpan di WIN. File INI, di bawah bagian [Windows}.

  • Waktu penundaan Seret Windows 95/98 disimpan dalam versi WIN yang di-cache. INI.

Untuk informasi selengkapnya tentang bagaimana informasi penundaan seret disimpan di registri atau . File INI, lihat WriteProfileString di Windows SDK.

COleClientItem::D oVerb

Panggil DoVerb untuk menjalankan kata kerja yang ditentukan.

virtual BOOL DoVerb(
    LONG nVerb,
    CView* pView,
    LPMSG lpMsg = NULL);

Parameter

nVerb
Menentukan kata kerja yang akan dijalankan. Ini dapat mencakup salah satu hal berikut:

Nilai Makna Simbol
0- Kata kerja utama OLEIVERB_PRIMARY
-1 Kata kerja sekunder (Tidak Ada)
-1 Tampilkan item untuk pengeditan OLEIVERB_SHOW
-2 Edit item di jendela terpisah OLEIVERB_OPEN
-3 Sembunyikan item OLEIVERB_HIDE

Nilai -1 biasanya merupakan alias untuk kata kerja lain. Jika pengeditan terbuka tidak didukung, -2 memiliki efek yang sama dengan -1. Untuk nilai tambahan, lihat IOleObject::D oVerb di Windows SDK.

pView
Penunjuk ke jendela tampilan; ini digunakan oleh server untuk aktivasi di tempat. Parameter ini harus NULL jika aplikasi kontainer tidak mengizinkan aktivasi di tempat.

lpMsg
Penunjuk ke pesan yang menyebabkan item diaktifkan.

Tampilkan Nilai

Bukan nol jika kata kerja berhasil dijalankan; jika tidak, 0.

Keterangan

Fungsi ini memanggil fungsi Aktifkan anggota untuk menjalankan kata kerja. Ini juga menangkap pengecualian dan menampilkan kotak pesan kepada pengguna jika ada yang dilemparkan.

Jika kata kerja utama adalah Edit dan nol ditentukan dalam parameter nVerb , aplikasi server diluncurkan untuk memungkinkan item OLE diedit. Jika aplikasi kontainer mendukung aktivasi di tempat, pengeditan dapat dilakukan di tempat. Jika kontainer tidak mendukung aktivasi di tempat (atau jika kata kerja Buka ditentukan), server diluncurkan di jendela terpisah dan pengeditan dapat dilakukan di sana. Biasanya, ketika pengguna aplikasi kontainer mengklik dua kali item OLE, nilai untuk kata kerja utama dalam parameter nVerb menentukan tindakan mana yang dapat diambil pengguna. Namun, jika server hanya mendukung satu tindakan, ia mengambil tindakan tersebut, tidak peduli nilai mana yang ditentukan dalam parameter nVerb .

COleClientItem::D raw

Panggil fungsi ini untuk menggambar item OLE ke dalam persegi panjang pembatas yang ditentukan menggunakan konteks perangkat yang ditentukan.

BOOL Draw(
    CDC* pDC,
    LPCRECT lpBounds,
    DVASPECT nDrawAspect = (DVASPECT)-1);

Parameter

pDC
Penunjuk ke objek CDC yang digunakan untuk menggambar item OLE.

lpBounds
Penunjuk ke objek atau RECT struktur CRect yang menentukan persegi panjang pembatas untuk menggambar item OLE (dalam unit logis yang ditentukan oleh konteks perangkat).

nDrawAspect
Menentukan aspek item OLE, yaitu bagaimana item tersebut harus ditampilkan. Jika nDrawAspect adalah -1, aspek terakhir yang ditetapkan dengan menggunakan SetDrawAspect digunakan. Untuk informasi selengkapnya tentang kemungkinan nilai untuk bendera ini, lihat SetDrawAspect.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Fungsi ini dapat menggunakan representasi metafile dari item OLE yang dibuat oleh fungsi anggota OnDraw dari COleServerItem.

Biasanya Anda menggunakan Draw untuk tampilan layar, melewati konteks perangkat layar sebagai pDC. Dalam hal ini, Anda hanya perlu menentukan dua parameter pertama.

Parameter lpBounds mengidentifikasi persegi panjang dalam konteks perangkat target (relatif terhadap mode pemetaannya saat ini). Penyajian dapat melibatkan penskalakan gambar dan dapat digunakan oleh aplikasi kontainer untuk memaksakan tampilan yang menskalakan antara tampilan yang ditampilkan dan gambar cetak akhir.

Untuk informasi selengkapnya, lihat IViewObject::D raw di Windows SDK.

COleClientItem::GetActiveView

Mengembalikan tampilan tempat item diaktifkan.

CView* GetActiveView() const;

Tampilkan Nilai

Penunjuk ke tampilan; jika tidak, NULL jika item tidak diaktifkan di tempat.

COleClientItem::GetCachedExtent

Panggil fungsi ini untuk mengambil ukuran item OLE.

BOOL GetCachedExtent(
    LPSIZE lpSize,
    DVASPECT nDrawAspect = (DVASPECT)-1);

Parameter

lpSize
Penunjuk SIZE ke struktur atau objek CSize yang akan menerima informasi ukuran.

nDrawAspect
Menentukan aspek item OLE yang batasnya akan diambil. Untuk nilai yang mungkin, lihat SetDrawAspect.

Tampilkan Nilai

Bukan nol jika berhasil; 0 jika item OLE kosong.

Keterangan

Fungsi ini menyediakan informasi yang sama dengan GetExtent. Namun, Anda dapat memanggil GetCachedExtent untuk mendapatkan informasi luas selama pemrosesan handler OLE lainnya, seperti OnChange. Dimensi berada dalam unit MM_HIMETRIC.

Ini dimungkinkan karena GetCachedExtent menggunakan antarmuka IViewObject2 daripada menggunakan antarmuka IOleObject untuk mendapatkan sejauh mana item ini. Objek IViewObject2 COM menyimpan informasi tingkat yang digunakan dalam panggilan sebelumnya ke IViewObject::D raw.

Untuk informasi selengkapnya, lihat IViewObject2::GetExtent di Windows SDK.

COleClientItem::GetClassID

Mengembalikan ID kelas item ke dalam memori yang ditujukkan oleh pClassID.

void GetClassID(CLSID* pClassID) const;

Parameter

pClassID
Penunjuk ke pengidentifikasi jenis CLSID untuk mengambil ID kelas. Untuk informasi tentang CLSID, lihat Windows SDK.

Keterangan

ID kelas adalah angka 128-bit yang secara unik mengidentifikasi aplikasi yang mengedit item.

Untuk informasi selengkapnya, lihat IPersist::GetClassID di Windows SDK.

COleClientItem::GetClipboardData

Panggil fungsi ini untuk mendapatkan objek yang COleDataSource berisi semua data yang akan ditempatkan di Clipboard dengan panggilan ke fungsi anggota CopyToClipboard .

void GetClipboardData(
    COleDataSource* pDataSource,
    BOOL bIncludeLink = FALSE,
    LPPOINT lpOffset = NULL,
    LPSIZE lpSize = NULL);

Parameter

pDataSource
Penunjuk ke objek COleDataSource yang akan menerima data yang terkandung dalam item OLE.

bIncludeLink
TRUE jika data tautan harus disertakan; jika tidak FALSE.

lpOffset
Offset kursor mouse dari asal objek dalam piksel.

lpSize
Ukuran objek dalam piksel.

Keterangan

GetClipboardData disebut sebagai implementasi default OnGetClipboardData. Ambil alih OnGetClipboardData hanya jika Anda ingin menawarkan format data selain yang ditawarkan oleh CopyToClipboard. Tempatkan format tersebut COleDataSource di objek sebelum atau sesudah memanggil CopyToClipboard, lalu teruskan COleDataSource objek ke fungsi COleDataSource::SetClipboard . Misalnya, jika Anda ingin posisi item OLE dalam dokumen kontainernya menyertainya di Clipboard, Anda akan menentukan format Anda sendiri untuk meneruskan informasi tersebut COleDataSource dan menempatkannya di sebelum memanggil CopyToClipboard.

COleClientItem::GetDocument

Panggil fungsi ini untuk mendapatkan penunjuk ke dokumen yang berisi item OLE.

COleDocument* GetDocument() const;

Tampilkan Nilai

Penunjuk ke dokumen yang berisi item OLE. NULL jika item bukan bagian dari dokumen.

Keterangan

Penunjuk ini memungkinkan akses ke COleDocument objek yang Anda teruskan sebagai argumen ke COleClientItem konstruktor.

COleClientItem::GetDrawAspect

GetDrawAspect Panggil fungsi anggota untuk menentukan "aspek", atau tampilan item saat ini.

DVASPECT GetDrawAspect() const;

Tampilkan Nilai

Nilai dari enumerasi DVASPECT, yang nilainya tercantum dalam referensi untuk SetDrawAspect.

Keterangan

Aspek menentukan bagaimana item akan dirender.

COleClientItem::GetExtent

Panggil fungsi ini untuk mengambil ukuran item OLE.

BOOL GetExtent(
    LPSIZE lpSize,
    DVASPECT nDrawAspect = (DVASPECT)- 1);

Parameter

lpSize
Penunjuk SIZE ke struktur atau CSize objek yang akan menerima informasi ukuran.

nDrawAspect
Menentukan aspek item OLE yang batasnya akan diambil. Untuk nilai yang mungkin, lihat SetDrawAspect.

Tampilkan Nilai

Bukan nol jika berhasil; 0 jika item OLE kosong.

Keterangan

Jika aplikasi server ditulis menggunakan Pustaka Kelas Microsoft Foundation, fungsi ini menyebabkan fungsi anggota OnGetExtent dari objek yang COleServerItem sesuai dipanggil. Perhatikan bahwa ukuran yang diambil mungkin berbeda dari ukuran yang terakhir ditetapkan oleh fungsi anggota SetExtent ; ukuran yang ditentukan oleh SetExtent diperlakukan sebagai saran. Dimensi berada dalam unit MM_HIMETRIC.

Catatan

Jangan memanggil GetExtent selama pemrosesan handler OLE, seperti OnChange. Panggil GetCachedExtent sebagai gantinya.

Untuk informasi selengkapnya, lihat IOleObject::GetExtent di Windows SDK.

COleClientItem::GetIconFromRegistry

Panggil fungsi anggota ini untuk mengambil handel ke sumber daya ikon yang terkait dengan server CLSID tertentu.

HICON GetIconFromRegistry() const;

static HICON GetIconFromRegistry(CLSID& clsid);

Parameter

clsid
Referensi ke CLSID untuk server yang terkait dengan ikon.

Tampilkan Nilai

Handel yang valid ke sumber daya ikon, atau NULL jika ikon server, atau ikon default, tidak dapat ditemukan.

Keterangan

Fungsi anggota ini tidak akan memulai server atau mendapatkan ikon secara dinamis, bahkan jika server sudah berjalan. Sebaliknya, fungsi anggota ini membuka gambar server yang dapat dieksekusi dan mengambil ikon statis yang terkait dengan server saat terdaftar.

COleClientItem::GetIconicMetafile

Mengambil metafile yang digunakan untuk menggambar ikon item.

HGLOBAL GetIconicMetafile();

Tampilkan Nilai

Handel ke metafile jika berhasil; jika tidak, NULL.

Keterangan

Jika tidak ada ikon saat ini, ikon default dikembalikan. Ini dipanggil secara otomatis oleh dialog MFC/OLE dan biasanya tidak dipanggil secara langsung.

Fungsi ini juga memanggil SetIconicMetafile untuk menyimpan metafile untuk digunakan nanti.

COleClientItem::GetInPlaceWindow

GetInPlaceWindow Panggil fungsi anggota untuk mendapatkan penunjuk ke jendela tempat item telah dibuka untuk pengeditan di tempat.

CWnd* GetInPlaceWindow();

Tampilkan Nilai

Penunjuk ke jendela pengeditan item di tempat; NULL jika item tidak aktif atau jika servernya tidak tersedia.

Keterangan

Fungsi ini harus dipanggil hanya untuk item yang aktif di tempat.

COleClientItem::GetItemState

Panggil fungsi ini untuk mendapatkan status item OLE saat ini.

UINT GetItemState() const;

Tampilkan Nilai

Nilai COleClientItem::ItemState enumerasi, yang dapat menjadi salah satu dari berikut ini: emptyState, , openStateloadedState, activeState, activeUIState. Untuk informasi tentang status ini, lihat artikel Kontainer: Status Klien-Item.

Keterangan

Untuk diberi tahu saat status item OLE berubah, gunakan fungsi anggota OnChange .

Untuk informasi selengkapnya, lihat artikel Kontainer: Status Klien-Item.

COleClientItem::GetLastStatus

Mengembalikan kode status operasi OLE terakhir.

SCODE GetLastStatus() const;

Tampilkan Nilai

Nilai SCODE.

Keterangan

Untuk fungsi anggota yang mengembalikan nilai BOOL FALSE, atau fungsi anggota lain yang mengembalikan NULL, GetLastStatus mengembalikan informasi kegagalan yang lebih rinci. Ketahuilah bahwa sebagian besar fungsi anggota OLE melemparkan pengecualian untuk kesalahan yang lebih serius. Informasi spesifik tentang interpretasi SCODE tergantung pada panggilan OLE yang mendasar yang terakhir mengembalikan nilai SCODE.

Untuk informasi selengkapnya tentang SCODE, lihat Struktur Kode Kesalahan COM dalam dokumentasi Windows SDK.

COleClientItem::GetLinkUpdateOptions

Panggil fungsi ini untuk mendapatkan nilai opsi pembaruan tautan saat ini untuk item OLE.

OLEUPDATE GetLinkUpdateOptions();

Tampilkan Nilai

Salah satu dari nilai berikut:

  • OLEUPDATE_ALWAYS Perbarui item tertaut jika memungkinkan. Opsi ini mendukung tombol radio Pembaruan tautan otomatis dalam kotak dialog Tautan.

  • OLEUPDATE_ONCALL Perbarui item tertaut hanya berdasarkan permintaan dari aplikasi kontainer (saat fungsi anggota UpdateLink dipanggil). Opsi ini mendukung tombol radio Pembaruan tautan manual dalam kotak dialog Tautan.

Keterangan

Ini adalah operasi lanjutan.

Fungsi ini dipanggil secara otomatis oleh kelas COleLinksDialog .

Untuk informasi selengkapnya, lihat IOleLink::GetUpdateOptions di Windows SDK.

COleClientItem::GetType

Panggil fungsi ini untuk menentukan apakah item OLE disematkan atau ditautkan, atau statis.

OLE_OBJTYPE GetType() const;

Tampilkan Nilai

Bilangan bulat yang tidak ditandatangani dengan salah satu nilai berikut:

  • OT_LINK Item OLE adalah tautan.

  • OT_EMBEDDED Item OLE disematkan.

  • OT_STATIC Item OLE bersifat statis, artinya, hanya berisi data presentasi, bukan data asli, dan dengan demikian tidak dapat diedit.

COleClientItem::GetUserType

Panggil fungsi ini untuk mendapatkan string yang terlihat pengguna yang menjelaskan jenis item OLE, seperti "Dokumen Word."

void GetUserType(
    USERCLASSTYPE nUserClassType,
    CString& rString);

Parameter

nUserClassType
Nilai yang menunjukkan varian string yang diinginkan yang menjelaskan jenis item OLE. Ini bisa memiliki salah satu nilai berikut:

  • USERCLASSTYPE_FULL Nama jenis lengkap yang ditampilkan kepada pengguna.

  • USERCLASSTYPE_SHORT Nama pendek (maksimum 15 karakter) untuk digunakan dalam menu pop-up dan kotak dialog Edit Tautan.

  • USERCLASSTYPE_APPNAME Nama aplikasi yang melayani kelas.

rString
Referensi ke objek CString tempat string yang menjelaskan jenis item OLE akan dikembalikan.

Keterangan

Ini sering kali merupakan entri dalam database pendaftaran sistem.

Jika nama jenis lengkap diminta tetapi tidak tersedia, nama pendek digunakan sebagai gantinya. Jika tidak ada entri untuk jenis item OLE yang ditemukan di database pendaftaran, atau jika tidak ada jenis pengguna yang terdaftar untuk jenis item OLE, maka jenis pengguna yang saat ini disimpan dalam item OLE digunakan. Jika nama jenis pengguna tersebut adalah string kosong, "Objek Tidak Diketahui" digunakan.

Untuk informasi selengkapnya, lihat IOleObject::GetUserType di Windows SDK.

COleClientItem::IsInPlaceActive

Panggil fungsi ini untuk melihat apakah item OLE aktif di tempat.

BOOL IsInPlaceActive() const;

Tampilkan Nilai

Bukan nol jika item OLE aktif di tempat; jika tidak, 0.

Keterangan

Adalah umum untuk menjalankan logika yang berbeda tergantung pada apakah item sedang diedit di tempat. Fungsi memeriksa apakah status item saat ini sama dengan activeState atau activeUIState.

COleClientItem::IsLinkUpToDate

Panggil fungsi ini untuk melihat apakah item OLE sudah diperbarui.

BOOL IsLinkUpToDate() const;

Tampilkan Nilai

Bukan nol jika item OLE sudah diperbarui; jika tidak, 0.

Keterangan

Item tertaut bisa kedaluarsa jika dokumen sumbernya telah diperbarui. Item yang disematkan yang berisi tautan di dalamnya juga bisa menjadi kedaluarsa. Fungsi ini melakukan pemeriksaan rekursif item OLE. Perhatikan bahwa menentukan apakah item OLE sudah kedaluarsa bisa semahal melakukan pembaruan.

Ini dipanggil secara otomatis oleh implementasi COleLinksDialog .

Untuk informasi selengkapnya, lihat IOleObject::IsUpToDate di Windows SDK.

COleClientItem::IsModified

Panggil fungsi ini untuk melihat apakah item OLE kotor (dimodifikasi sejak terakhir disimpan).

BOOL IsModified() const;

Tampilkan Nilai

Bukan nol jika item OLE kotor; jika tidak, 0.

Keterangan

Untuk informasi selengkapnya, lihat IPersistStorage::IsDirty di Windows SDK.

COleClientItem::IsOpen

Panggil fungsi ini untuk melihat apakah item OLE terbuka; yaitu, dibuka dalam instans aplikasi server yang berjalan di jendela terpisah.

BOOL IsOpen() const;

Tampilkan Nilai

Bukan nol jika item OLE terbuka; jika tidak, 0.

Keterangan

Ini digunakan untuk menentukan kapan harus menggambar objek dengan pola penetasan. Objek terbuka harus memiliki pola hatch yang digambar di atas objek. Anda dapat menggunakan objek CRectTracker untuk mencapai hal ini.

COleClientItem::IsRunning

Panggil fungsi ini untuk melihat apakah item OLE berjalan; yaitu, apakah item dimuat dan berjalan di aplikasi server.

BOOL IsRunning() const;

Tampilkan Nilai

Bukan nol jika item OLE berjalan; jika tidak, 0.

Keterangan

Untuk informasi selengkapnya, lihat OleIsRunning di Windows SDK.

COleClientItem::OnActivate

Dipanggil oleh kerangka kerja untuk memberi tahu item bahwa item baru saja diaktifkan.

virtual void OnActivate();

Keterangan

Perhatikan bahwa fungsi ini dipanggil untuk menunjukkan bahwa server sedang berjalan, bukan untuk menunjukkan bahwa antarmuka penggunanya telah diinstal dalam aplikasi kontainer. Pada titik ini, objek tidak memiliki antarmuka pengguna aktif (bukan activeUIState). Ini belum menginstal menu atau bilah alatnya. Fungsi anggota OnActivateUI dipanggil ketika itu terjadi.

Implementasi default memanggil fungsi anggota OnChange dengan OLE_CHANGEDSTATE sebagai parameter. Ambil alih fungsi ini untuk melakukan pemrosesan kustom saat item menjadi aktif di tempat.

COleClientItem::OnActivateUI

Kerangka kerja memanggil OnActivateUI ketika objek telah memasuki status UI aktif.

virtual void OnActivateUI();

Keterangan

Objek sekarang telah menginstal bilah alat dan menunya.

Implementasi default mengingat HWND server untuk panggilan nanti GetServerWindow .

COleClientItem::OnChange

Dipanggil oleh kerangka kerja saat pengguna memodifikasi, menyimpan, atau menutup item OLE.

virtual void OnChange(
    OLE_NOTIFICATION nCode,
    DWORD dwParam);

Parameter

nCode
Alasan server mengubah item ini. Ini dapat memiliki salah satu nilai berikut:

  • OLE_CHANGED Tampilan item OLE telah berubah.

  • OLE_SAVED Item OLE telah disimpan.

  • OLE_CLOSED Item OLE telah ditutup.

  • OLE_CHANGED_STATE Item OLE telah berubah dari satu status ke status lainnya.

dwParam
Jika nCode OLE_SAVED atau OLE_CLOSED, parameter ini tidak digunakan. Jika nCode OLE_CHANGED, parameter ini menentukan aspek item OLE yang telah berubah. Untuk nilai yang mungkin, lihat parameter dwParam dari COleClientItem::D raw. Jika nCode OLE_CHANGED_STATE, parameter ini adalah COleClientItem::ItemState nilai enumerasi dan menjelaskan status yang dimasukkan. Ini dapat memiliki salah satu nilai berikut: emptyState, , loadedState, openStateactiveState, atau activeUIState.

Keterangan

(Jika aplikasi server ditulis menggunakan Pustaka Kelas Microsoft Foundation, fungsi ini dipanggil sebagai Notify respons terhadap fungsi COleServerDoc anggota atau COleServerItem.) Implementasi default menandai dokumen kontainer sebagai dimodifikasi jika nCode OLE_CHANGED atau OLE_SAVED.

Untuk OLE_CHANGED_STATE, status saat ini yang dikembalikan dari GetItemState masih akan menjadi status lama, yang berarti status yang saat ini sebelum perubahan status ini.

Ambil alih fungsi ini untuk merespons perubahan dalam status item OLE. Biasanya Anda memperbarui tampilan item dengan membatalkan area tempat item ditampilkan. Panggil implementasi kelas dasar di awal penimpaan Anda.

COleClientItem::OnChangeItemPosition

Dipanggil oleh kerangka kerja untuk memberi tahu kontainer bahwa tingkat item OLE telah berubah selama aktivasi di tempat.

virtual BOOL OnChangeItemPosition(const CRect& rectPos);

Parameter

rectPos
Menunjukkan posisi item relatif terhadap area klien aplikasi kontainer.

Tampilkan Nilai

Bukan nol jika posisi item berhasil diubah; jika tidak, 0.

Keterangan

Implementasi default menentukan persegi panjang baru yang terlihat dari item OLE dan memanggil SetItemRects dengan nilai baru. Implementasi default menghitung persegi panjang yang terlihat untuk item dan meneruskan informasi tersebut ke server.

Ambil alih fungsi ini untuk menerapkan aturan khusus pada operasi mengubah ukuran/memindahkan. Jika aplikasi ditulis dalam MFC, panggilan ini menghasilkan karena server yang disebut COleServerDoc::RequestPositionChange.

COleClientItem::OnDeactivate

Dipanggil oleh kerangka kerja ketika item OLE beralih dari status aktif di tempat ( activeState) ke status dimuat, yang berarti bahwa item dinonaktifkan setelah aktivasi di tempat.

virtual void OnDeactivate();

Keterangan

Perhatikan bahwa fungsi ini dipanggil untuk menunjukkan bahwa item OLE ditutup, bukan berarti antarmuka penggunanya telah dihapus dari aplikasi kontainer. Ketika itu terjadi, fungsi anggota OnDeactivateUI dipanggil.

Implementasi default memanggil fungsi anggota OnChange dengan OLE_CHANGEDSTATE sebagai parameter. Ambil alih fungsi ini untuk melakukan pemrosesan kustom saat item aktif di tempat dinonaktifkan. Misalnya, jika Anda mendukung perintah batalkan di aplikasi kontainer, Anda dapat mengambil alih fungsi ini untuk membuang status batalkan, yang menunjukkan bahwa operasi terakhir yang dilakukan pada item OLE tidak dapat dibatalkan setelah item dinonaktifkan.

COleClientItem::OnDeactivateAndUndo

Dipanggil oleh kerangka kerja ketika pengguna memanggil perintah batalkan setelah mengaktifkan item OLE di tempat.

virtual void OnDeactivateAndUndo();

Keterangan

Implementasi default memanggil NonaktifkanUI untuk menonaktifkan antarmuka pengguna server. Ambil alih fungsi ini jika Anda menerapkan perintah batalkan di aplikasi kontainer Anda. Dalam penimpaan Anda, panggil versi kelas dasar fungsi lalu batalkan perintah terakhir yang dijalankan di aplikasi Anda.

Untuk informasi selengkapnya, lihat IOleInPlaceSite::D eactivateAndUndo di Windows SDK.

COleClientItem::OnDeactivateUI

Dipanggil saat pengguna menonaktifkan item yang diaktifkan di tempat.

virtual void OnDeactivateUI(BOOL bUndoable);

Parameter

bUndoable
Menentukan apakah perubahan pengeditan tidak dapat diulang.

Keterangan

Fungsi ini memulihkan antarmuka pengguna aplikasi kontainer ke status aslinya, menyembunyikan menu apa pun dan kontrol lain yang dibuat untuk aktivasi di tempat.

Jika bUndoable FALSE, kontainer harus menonaktifkan perintah batalkan, yang berlaku untuk membuang status batalkan kontainer, karena menunjukkan bahwa operasi terakhir yang dilakukan oleh server tidak dapat dibatalkan.

COleClientItem::OnDiscardUndoState

Dipanggil oleh kerangka kerja saat pengguna melakukan tindakan yang membuang status batalkan saat mengedit item OLE.

virtual void OnDiscardUndoState();

Keterangan

Implementasi default tidak melakukan apa pun. Ambil alih fungsi ini jika Anda menerapkan perintah batalkan di aplikasi kontainer Anda. Dalam penimpaan Anda, buang status batalkan aplikasi kontainer.

Jika server ditulis dengan Pustaka Kelas Microsoft Foundation, server dapat menyebabkan fungsi ini dipanggil dengan memanggil COleServerDoc::D iscardUndoState.

Untuk informasi selengkapnya, lihat IOleInPlaceSite::D iscardUndoState di Windows SDK.

COleClientItem::OnGetClipboardData

Dipanggil oleh kerangka kerja untuk mendapatkan objek yang COleDataSource berisi semua data yang akan ditempatkan di Clipboard dengan panggilan ke copyToClipboard atau fungsi anggota DoDragDrop .

virtual COleDataSource* OnGetClipboardData(
    BOOL bIncludeLink,
    LPPOINT lpOffset,
    LPSIZE lpSize);

Parameter

bIncludeLink
Atur ini ke TRUE jika data tautan harus disalin ke Clipboard. Atur ini ke FALSE jika aplikasi server Anda tidak mendukung tautan.

lpOffset
Penunjuk ke offset kursor mouse dari asal objek dalam piksel.

lpSize
Penunjuk ke ukuran objek dalam piksel.

Tampilkan Nilai

Penunjuk ke objek COleDataSource yang berisi data Clipboard.

Keterangan

Implementasi default fungsi ini memanggil GetClipboardData.

COleClientItem::OnGetClipRect

Kerangka kerja memanggil OnGetClipRect fungsi anggota untuk mendapatkan koordinat kliping-persegi panjang item yang sedang diedit di tempat.

virtual void OnGetClipRect(CRect& rClipRect);

Parameter

rClipRect
Penunjuk ke objek CRect kelas yang akan menyimpan koordinat kliping-persegi panjang item.

Keterangan

Koordinat dalam piksel relatif terhadap area klien jendela aplikasi kontainer.

Implementasi default hanya mengembalikan persegi panjang klien dari tampilan tempat item aktif.

COleClientItem::OnGetItemPosition

Kerangka kerja memanggil OnGetItemPosition fungsi anggota untuk mendapatkan koordinat item yang sedang diedit.

virtual void OnGetItemPosition(CRect& rPosition);

Parameter

rPosisi
Referensi ke objek CRect yang akan berisi koordinat posisi item.

Keterangan

Koordinat dalam piksel relatif terhadap area klien jendela aplikasi kontainer.

Implementasi default fungsi ini tidak melakukan apa pun. Aplikasi yang mendukung pengeditan di tempat memerlukan implementasinya.

COleClientItem::OnGetWindowContext

Dipanggil oleh kerangka kerja saat item diaktifkan di tempat.

virtual BOOL OnGetWindowContext(
    CFrameWnd** ppMainFrame,
    CFrameWnd** ppDocFrame,
    LPOLEINPLACEFRAMEINFO lpFrameInfo);

Parameter

ppMainFrame
Arahkan ke penunjuk ke jendela bingkai utama.

ppDocFrame
Penunjuk ke penunjuk ke jendela bingkai dokumen.

lpFrameInfo
Arahkan ke struktur OLEINPLACEFRAMEINFO yang akan menerima informasi jendela bingkai.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Fungsi ini digunakan untuk mengambil informasi tentang jendela induk item OLE.

Jika kontainer adalah aplikasi MDI, implementasi default mengembalikan pointer ke objek CMDIFrameWnd di ppMainFrame dan pointer ke objek CMDIChildWnd aktif di ppDocFrame. Jika kontainer adalah aplikasi SDI, implementasi default mengembalikan pointer ke objek CFrameWnd di ppMainFrame dan mengembalikan NULL di ppDocFrame. Implementasi default juga mengisi anggota lpFrameInfo.

Ambil alih fungsi ini hanya jika implementasi default tidak sesuai dengan aplikasi Anda; misalnya, jika aplikasi Anda memiliki paradigma antarmuka pengguna yang berbeda dari SDI atau MDI. Ini adalah pengalih tingkat lanjut.

Untuk informasi selengkapnya, lihat IOleInPlaceSite::GetWindowContext dan struktur OLEINPLACEFRAMEINFO di Windows SDK.

COleClientItem::OnInsertMenus

Dipanggil oleh kerangka kerja selama aktivasi di tempat untuk menyisipkan menu aplikasi kontainer ke dalam menu kosong.

virtual void OnInsertMenus(
    CMenu* pMenuShared,
    LPOLEMENUGROUPWIDTHS lpMenuWidths);

Parameter

pMenuShared
Menunjuk ke menu kosong.

lpMenuWidths
Menunjuk ke array enam nilai LONG yang menunjukkan berapa banyak menu yang ada di setiap grup menu berikut: File, Edit, Kontainer, Objek, Jendela, Bantuan. Aplikasi kontainer bertanggung jawab atas grup menu File, Kontainer, dan Jendela, yang sesuai dengan elemen 0, 2, dan 4 array ini.

Keterangan

Menu ini kemudian diteruskan ke server, yang menyisipkan menunya sendiri, membuat menu komposit. Fungsi ini dapat dipanggil berulang kali untuk membangun beberapa menu komposit.

Implementasi default dimasukkan ke dalam pMenuShared menu kontainer di tempat; yaitu, grup menu File, Kontainer, dan Jendela. CDocTemplate::SetContainerInfo digunakan untuk mengatur sumber daya menu ini. Implementasi default juga menetapkan nilai yang sesuai ke elemen 0, 2, dan 4 di lpMenuWidths, tergantung pada sumber daya menu. Ambil alih fungsi ini jika implementasi default tidak sesuai untuk aplikasi Anda; misalnya, jika aplikasi Anda tidak menggunakan templat dokumen untuk mengaitkan sumber daya dengan jenis dokumen. Jika Anda mengambil alih fungsi ini, Anda juga harus mengambil alih OnSetMenu dan OnRemoveMenus. Ini adalah pengalih tingkat lanjut.

Untuk informasi selengkapnya, lihat IOleInPlaceFrame::InsertMenus di Windows SDK.

COleClientItem::OnRemoveMenus

Dipanggil oleh kerangka kerja untuk menghapus menu kontainer dari menu komposit yang ditentukan saat aktivasi di tempat berakhir.

virtual void OnRemoveMenus(CMenu* pMenuShared);

Parameter

pMenuShared
Menunjuk ke menu komposit yang dibangun oleh panggilan ke fungsi anggota OnInsertMenus .

Keterangan

Implementasi default dihapus dari pMenuShared menu kontainer di tempat, yaitu, grup menu File, Kontainer, dan Jendela. Ambil alih fungsi ini jika implementasi default tidak sesuai untuk aplikasi Anda; misalnya, jika aplikasi Anda tidak menggunakan templat dokumen untuk mengaitkan sumber daya dengan jenis dokumen. Jika Anda mengambil alih fungsi ini, Anda mungkin harus mengambil alih OnInsertMenus dan OnSetMenu juga. Ini adalah pengalih tingkat lanjut.

Submenus pada pMenuShared dapat dibagikan oleh lebih dari satu menu komposit jika server telah berulang kali memanggil OnInsertMenus. Oleh karena itu Anda tidak boleh menghapus submenu apa pun dalam penimpaan OnRemoveMenusAnda ; Anda hanya boleh melepaskannya.

Untuk informasi selengkapnya, lihat IOleInPlaceFrame::RemoveMenus di Windows SDK.

COleClientItem::OnScrollBy

Dipanggil oleh kerangka kerja untuk menggulir item OLE sebagai respons terhadap permintaan dari server.

virtual BOOL OnScrollBy(CSize sizeExtent);

Parameter

sizeExtent
Menentukan jarak, dalam piksel, untuk menggulir arah x dan y.

Tampilkan Nilai

Bukan nol jika item digulir; 0 jika item tidak dapat digulir.

Keterangan

Misalnya, jika item OLE terlihat sebagian dan pengguna berpindah ke luar wilayah yang terlihat saat melakukan pengeditan di tempat, fungsi ini dipanggil untuk menjaga kursor tetap terlihat. Implementasi default tidak melakukan apa pun. Ambil alih fungsi ini untuk menggulir item dengan jumlah yang ditentukan. Perhatikan bahwa sebagai akibat dari pengguliran, bagian yang terlihat dari item OLE dapat berubah. Panggil SetItemRects untuk memperbarui persegi panjang item yang terlihat.

Untuk informasi selengkapnya, lihat IOleInPlaceSite::Scroll di Windows SDK.

COleClientItem::OnSetMenu

Dipanggil oleh kerangka kerja dua kali ketika aktivasi di tempat dimulai dan berakhir; pertama kali menginstal menu komposit dan kedua kalinya (dengan holemenu sama dengan NULL) untuk menghapusnya.

virtual void OnSetMenu(
    CMenu* pMenuShared,
    HOLEMENU holemenu,
    HWND hwndActiveObject);

Parameter

pMenuShared
Penunjuk ke menu komposit yang dibangun oleh panggilan ke fungsi anggota OnInsertMenus dan InsertMenu fungsi .

holemenu
Tangani ke deskriptor menu yang dikembalikan oleh OleCreateMenuDescriptor fungsi, atau NULL jika kode pengiriman akan dihapus.

hwndActiveObject
Tangani ke jendela pengeditan untuk item OLE. Ini adalah jendela yang akan menerima perintah pengeditan dari OLE.

Keterangan

Implementasi default menginstal atau menghapus menu komposit lalu memanggil fungsi OleSetMenuDescriptor untuk menginstal atau menghapus kode pengiriman. Ambil alih fungsi ini jika implementasi default tidak sesuai untuk aplikasi Anda. Jika Anda mengambil alih fungsi ini, Anda mungkin harus mengambil alih OnInsertMenus dan OnRemoveMenus juga. Ini adalah pengalih tingkat lanjut.

Untuk informasi selengkapnya, lihat OleCreateMenuDescriptor, OleSetMenuDescriptor, dan IOleInPlaceFrame::SetMenu di Windows SDK.

COleClientItem::OnShowControlBars

Dipanggil oleh kerangka kerja untuk menampilkan dan menyembunyikan bilah kontrol aplikasi kontainer.

virtual BOOL OnShowControlBars(
    CFrameWnd* pFrameWnd,
    BOOL bShow);

Parameter

pFrameWnd
Penunjuk ke jendela bingkai aplikasi kontainer. Ini bisa berupa jendela bingkai utama atau jendela anak MDI.

bShow
Menentukan apakah bilah kontrol akan ditampilkan atau disembunyikan.

Tampilkan Nilai

Bukan nol jika panggilan fungsi menyebabkan perubahan dalam status bilah kontrol; 0 jika panggilan tidak menyebabkan perubahan, atau jika pFrameWnd tidak menunjuk ke jendela bingkai kontainer.

Keterangan

Fungsi ini mengembalikan 0 jika bilah kontrol sudah dalam status yang ditentukan oleh bShow. Ini akan terjadi, misalnya, jika bilah kontrol disembunyikan dan bShow FALSE.

Implementasi default menghapus toolbar dari jendela bingkai tingkat atas.

COleClientItem::OnShowItem

Dipanggil oleh kerangka kerja untuk menampilkan item OLE, membuatnya benar-benar terlihat selama pengeditan.

virtual void OnShowItem();

Keterangan

Ini digunakan ketika aplikasi kontainer Anda mendukung tautan ke item yang disematkan (yaitu, jika Anda telah memperoleh kelas dokumen Anda dari COleLinkingDoc). Fungsi ini dipanggil selama aktivasi di tempat atau ketika item OLE adalah sumber tautan dan pengguna ingin mengeditnya. Implementasi default mengaktifkan tampilan pertama pada dokumen kontainer. Ambil alih fungsi ini untuk menggulir dokumen sehingga item OLE terlihat.

COleClientItem::OnUpdateFrameTitle

Dipanggil oleh kerangka kerja selama aktivasi di tempat untuk memperbarui bilah judul jendela bingkai.

virtual BOOL OnUpdateFrameTitle();

Tampilkan Nilai

Bukan nol jika fungsi ini berhasil memperbarui judul bingkai, jika tidak, nol.

Keterangan

Implementasi default tidak mengubah judul jendela bingkai. Ambil alih fungsi ini jika Anda menginginkan judul bingkai yang berbeda untuk aplikasi Anda, misalnya " item aplikasi - server di docname" (seperti dalam, "Microsoft Excel - spreadsheet di REPORT.DOC"). Ini adalah pengalih tingkat lanjut.

COleClientItem::ReactivateAndUndo

Panggil fungsi ini untuk mengaktifkan kembali item OLE dan membatalkan operasi terakhir yang dilakukan oleh pengguna selama pengeditan di tempat.

BOOL ReactivateAndUndo();

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Jika aplikasi kontainer Anda mendukung perintah batalkan, panggil fungsi ini jika pengguna memilih perintah batalkan segera setelah menonaktifkan item OLE.

Jika aplikasi server ditulis dengan Microsoft Foundation Class Libraries, fungsi ini menyebabkan server memanggil COleServerDoc::OnReactivateAndUndo.

Untuk informasi selengkapnya, lihat IOleInPlaceObject::ReactivateAndUndo di Windows SDK.

COleClientItem::Release

Panggil fungsi ini untuk membersihkan sumber daya yang digunakan oleh item OLE.

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

Release dipanggil oleh COleClientItem destruktor.

Untuk informasi selengkapnya, lihat IUnknown::Release di Windows SDK.

COleClientItem::Reload

Menutup dan memuat ulang item.

BOOL Reload();

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Reload Panggil fungsi setelah mengaktifkan item sebagai item dari jenis lain dengan panggilan ke ActivateAs.

COleClientItem::Run

Menjalankan aplikasi yang terkait dengan item ini.

void Run();

Keterangan

Run Panggil fungsi anggota untuk meluncurkan aplikasi server sebelum mengaktifkan item. Ini dilakukan secara otomatis oleh Aktifkan dan DoVerb, sehingga biasanya tidak perlu memanggil fungsi ini. Panggil fungsi ini jika perlu menjalankan server untuk mengatur atribut item, seperti SetExtent, sebelum menjalankan DoVerb.

COleClientItem::SetDrawAspect

SetDrawAspect Panggil fungsi anggota untuk mengatur "aspek," atau tampilan, dari item.

virtual void SetDrawAspect(DVASPECT nDrawAspect);

Parameter

nDrawAspect
Nilai dari enumerasi DVASPECT. Parameter ini dapat memiliki salah satu nilai berikut:

  • DVASPECT_CONTENT Item diwakili sedimikian rupa sehingga dapat ditampilkan sebagai objek yang disematkan di dalam kontainernya.

  • DVASPECT_THUMBNAIL Item dirender dalam representasi "gambar mini" sehingga dapat ditampilkan dalam alat penjelajahan.

  • DVASPECT_ICON Item diwakili oleh ikon.

  • DVASPECT_DOCPRINT Item diwakili seolah-olah dicetak menggunakan perintah Cetak dari menu File.

Keterangan

Aspek menentukan bagaimana item akan dirender oleh Draw ketika nilai default untuk argumen nDrawAspect fungsi tersebut digunakan.

Fungsi ini dipanggil secara otomatis oleh Ikon Perubahan (dan dialog lain yang memanggil dialog Ubah Ikon secara langsung) untuk mengaktifkan aspek tampilan ikonik saat diminta oleh pengguna.

COleClientItem::SetExtent

Panggil fungsi ini untuk menentukan berapa banyak ruang yang tersedia untuk item OLE.

void SetExtent(
    const CSize& size,
    DVASPECT nDrawAspect = DVASPECT_CONTENT);

Parameter

ukuran
Objek CSize yang berisi informasi ukuran.

nDrawAspect
Menentukan aspek item OLE yang batasnya akan diatur. Untuk nilai yang mungkin, lihat SetDrawAspect.

Keterangan

Jika aplikasi server ditulis menggunakan Pustaka Kelas Microsoft Foundation, ini menyebabkan fungsi anggota OnSetExtent dari objek yang COleServerItem sesuai dipanggil. Item OLE kemudian dapat menyesuaikan tampilannya. Dimensi harus dalam unit MM_HIMETRIC. Panggil fungsi ini saat pengguna mengubah ukuran item OLE atau jika Anda mendukung beberapa bentuk negosiasi tata letak.

Untuk informasi selengkapnya, lihat IOleObject::SetExtent di Windows SDK.

COleClientItem::SetHostNames

Panggil fungsi ini untuk menentukan nama aplikasi kontainer dan nama kontainer untuk item OLE yang disematkan.

void SetHostNames(
    LPCTSTR lpszHost,
    LPCTSTR lpszHostObj);

Parameter

lpszHost
Penunjuk ke nama aplikasi kontainer yang terlihat pengguna.

lpszHostObj
Penunjuk ke string identifikasi kontainer yang berisi item OLE.

Keterangan

Jika aplikasi server ditulis menggunakan Pustaka Kelas Microsoft Foundation, fungsi ini memanggil fungsi anggota OnSetHostNames dari COleServerDoc dokumen yang berisi item OLE. Informasi ini digunakan dalam judul jendela ketika item OLE sedang diedit. Setiap kali dokumen kontainer dimuat, kerangka kerja memanggil fungsi ini untuk semua item OLE dalam dokumen. SetHostNames hanya berlaku untuk item yang disematkan. Tidak perlu memanggil fungsi ini setiap kali item OLE yang disematkan diaktifkan untuk pengeditan.

Ini juga dipanggil secara otomatis dengan nama aplikasi dan nama dokumen ketika objek dimuat atau ketika file disimpan dengan nama yang berbeda. Oleh karena itu, biasanya tidak perlu memanggil fungsi ini secara langsung.

Untuk informasi selengkapnya, lihat IOleObject::SetHostNames di Windows SDK.

COleClientItem::SetIconicMetafile

Cache metafile yang digunakan untuk menggambar ikon item.

BOOL SetIconicMetafile(HGLOBAL hMetaPict);

Parameter

hMetaPict
Handel ke metafile yang digunakan untuk menggambar ikon item.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Gunakan GetIconicMetafile untuk mengambil metafile.

Parameter hMetaPict disalin ke dalam item; oleh karena itu, hMetaPict harus dibebaskan oleh pemanggil.

COleClientItem::SetItemRects

Panggil fungsi ini untuk mengatur persegi panjang pembatas atau persegi panjang yang terlihat dari item OLE.

BOOL SetItemRects(
    LPCRECT lpPosRect = NULL,
    LPCRECT lpClipRect = NULL);

Parameter

lprcPosRect
Penunjuk ke persegi panjang yang berisi batas item OLE relatif terhadap jendela induknya, dalam koordinat klien.

lprcClipRect
Penunjuk ke persegi panjang yang berisi batas bagian item OLE yang terlihat relatif terhadap jendela induknya, dalam koordinat klien.

Tampilkan Nilai

Bukan nol jika berhasil; jika tidak, 0.

Keterangan

Fungsi ini dipanggil oleh implementasi default fungsi anggota OnChangeItemPosition . Anda harus memanggil fungsi ini setiap kali bagian posisi atau terlihat dari item OLE berubah. Biasanya ini berarti Anda menyebutnya dari fungsi anggota OnSize dan OnScrollBy tampilan Anda.

Untuk informasi selengkapnya, lihat IOleInPlaceObject::SetObjectRects di Windows SDK.

COleClientItem::SetLinkUpdateOptions

Panggil fungsi ini untuk mengatur opsi pembaruan tautan untuk presentasi item tertaut yang ditentukan.

void SetLinkUpdateOptions(OLEUPDATE dwUpdateOpt);

Parameter

dwUpdateOpt
Nilai opsi pembaruan tautan untuk item ini. Nilai ini harus salah satu dari yang berikut ini:

  • OLEUPDATE_ALWAYS Perbarui item tertaut jika memungkinkan. Opsi ini mendukung tombol radio Pembaruan tautan otomatis dalam kotak dialog Tautan.

  • OLEUPDATE_ONCALL Perbarui item tertaut hanya berdasarkan permintaan dari aplikasi kontainer (saat fungsi anggota UpdateLink dipanggil). Opsi ini mendukung tombol radio Pembaruan tautan manual dalam kotak dialog Tautan.

Keterangan

Biasanya, Anda tidak boleh mengubah opsi pembaruan yang dipilih oleh pengguna dalam kotak dialog Tautan.

Untuk informasi selengkapnya, lihat IOleLink::SetUpdateOptions di Windows SDK.

COleClientItem::SetPrintDevice

Panggil fungsi ini untuk mengubah perangkat target cetak untuk item ini.

BOOL SetPrintDevice(const DVTARGETDEVICE* ptd);
BOOL SetPrintDevice(const PRINTDLG* ppd);

Parameter

ptd
Penunjuk ke struktur data DVTARGETDEVICE , yang berisi informasi tentang perangkat target cetak baru. Bisa NULL.

Ppd
Penunjuk ke struktur data PRINTDLG , yang berisi informasi tentang perangkat target cetak baru. Bisa NULL.

Tampilkan Nilai

Bukan nol jika fungsi berhasil; jika tidak, 0.

Keterangan

Fungsi ini memperbarui perangkat target cetak untuk item tetapi tidak menyegarkan cache presentasi. Untuk memperbarui cache presentasi untuk item, panggil UpdateLink.

Argumen untuk fungsi ini berisi informasi yang digunakan sistem OLE untuk mengidentifikasi perangkat target. Struktur PRINTDLG berisi informasi yang digunakan Windows untuk menginisialisasi kotak dialog Cetak umum. Setelah pengguna menutup kotak dialog, Windows mengembalikan informasi tentang pilihan pengguna dalam struktur ini. Anggota m_pd objek CPrintDialog adalah PRINTDLG struktur.

Untuk informasi selengkapnya tentang struktur ini, lihat PRINTDLG di Windows SDK.

Untuk informasi selengkapnya, lihat DVTARGETDEVICE di Windows SDK.

Panggil fungsi ini untuk segera memperbarui data presentasi item OLE.

BOOL UpdateLink();

Tampilkan Nilai

Nonzero pada kesuksesan; jika tidak, 0.

Keterangan

Untuk item tertaut, fungsi menemukan sumber tautan untuk mendapatkan presentasi baru untuk item OLE. Proses ini mungkin melibatkan menjalankan satu atau beberapa aplikasi server, yang bisa memakan waktu. Untuk item yang disematkan, fungsi beroperasi secara rekursif, memeriksa apakah item yang disematkan berisi tautan yang mungkin kedaluarsa dan memperbaruinya. Pengguna juga dapat memperbarui tautan individual secara manual menggunakan kotak dialog Tautan.

Untuk informasi selengkapnya, lihat IOleLink::Update di Windows SDK.

Lihat juga

MFC Sampel MFCBIND
Sampel MFC OCLIENT
Kelas CDocItem
Bagan Hierarki
Kelas COleServerItem