Kelas COlePropertyPage

Digunakan untuk menampilkan properti kontrol kustom dalam antarmuka grafis, mirip dengan kotak dialog.

Sintaks

class AFX_NOVTABLE COlePropertyPage : public CDialog

Anggota

Konstruktor Publik

Nama	Deskripsi
COlePropertyPage::COlePropertyPage	Membuat COlePropertyPage objek.

Metode Publik

Nama	Deskripsi
COlePropertyPage::GetControlStatus	Menunjukkan apakah pengguna telah memodifikasi nilai dalam kontrol.
COlePropertyPage::GetObjectArray	Mengembalikan array objek yang sedang diedit oleh halaman properti.
COlePropertyPage::GetPageSite	Mengembalikan penunjuk ke antarmuka halaman IPropertyPageSite properti.
COlePropertyPage::IgnoreApply	Menentukan kontrol mana yang tidak mengaktifkan tombol Terapkan.
COlePropertyPage::IsModified	Menunjukkan apakah pengguna telah memodifikasi halaman properti.
COlePropertyPage::OnEditProperty	Dipanggil oleh kerangka kerja saat pengguna mengedit properti.
COlePropertyPage::OnHelp	Dipanggil oleh kerangka kerja saat pengguna memanggil bantuan.
COlePropertyPage::OnInitDialog	Dipanggil oleh kerangka kerja saat halaman properti diinisialisasi.
COlePropertyPage::OnObjectsChanged	Dipanggil oleh kerangka kerja ketika kontrol OLE lain, dengan properti baru, dipilih.
COlePropertyPage::OnSetpageSite	Dipanggil oleh kerangka kerja ketika bingkai properti menyediakan situs halaman.
COlePropertyPage::SetControlStatus	Mengatur bendera yang menunjukkan apakah pengguna telah memodifikasi nilai dalam kontrol.
COlePropertyPage::SetDialogResource	Mengatur sumber daya dialog halaman properti.
COlePropertyPage::SetHelpInfo	Mengatur teks bantuan singkat halaman properti, nama file bantuannya, dan konteks bantuannya.
COlePropertyPage::SetModifiedFlag	Mengatur bendera yang menunjukkan apakah pengguna telah memodifikasi halaman properti.
COlePropertyPage::SetPageName	Mengatur nama halaman properti (keterangan).

Keterangan

Misalnya, halaman properti dapat menyertakan kontrol edit yang memungkinkan pengguna untuk melihat dan memodifikasi properti keterangan kontrol.

Setiap properti kontrol kustom atau stok dapat memiliki kontrol dialog yang memungkinkan pengguna kontrol untuk melihat nilai properti saat ini dan mengubah nilai tersebut jika diperlukan.

Untuk informasi selengkapnya tentang menggunakan COlePropertyPage, lihat artikel Kontrol ActiveX: Halaman Properti.

Hierarki Warisan

CObject

CCmdTarget

CWnd

CDialog

COlePropertyPage

Persyaratan

Header: afxctl.h

COlePropertyPage::COlePropertyPage

Membuat COlePropertyPage objek.

COlePropertyPage(
    UINT idDlg,
    UINT idCaption);

Parameter

idDlg
ID sumber daya templat dialog.

idCaption
ID sumber daya dari keterangan halaman properti.

Keterangan

Saat Anda menerapkan subkelas , COlePropertyPagekonstruktor subkelas Anda harus menggunakan COlePropertyPage konstruktor untuk mengidentifikasi sumber daya templat dialog tempat halaman properti didasarkan dan sumber daya string yang berisi keterangannya.

COlePropertyPage::GetControlStatus

Menentukan apakah pengguna telah memodifikasi nilai kontrol halaman properti dengan ID sumber daya yang ditentukan.

BOOL GetControlStatus(UINT nID);

Parameter

Nid
ID sumber daya kontrol halaman properti.

Tampilkan Nilai

TRUE jika nilai kontrol telah dimodifikasi; jika tidak FALSE.

COlePropertyPage::GetObjectArray

Mengembalikan array objek yang sedang diedit oleh halaman properti.

LPDISPATCH* GetObjectArray(ULONG* pnObjects);

Parameter

pnObjects
Penunjuk ke bilangan bulat panjang yang tidak ditandatangani yang akan menerima jumlah objek yang diedit oleh halaman.

Tampilkan Nilai

Penunjuk ke array IDispatch pointer, yang digunakan untuk mengakses properti setiap kontrol pada halaman properti. Pemanggil tidak boleh melepaskan penunjuk antarmuka ini.

Keterangan

Setiap objek halaman properti mempertahankan array pointer ke IDispatch antarmuka objek yang sedang diedit oleh halaman. Fungsi ini mengatur argumen pnObjects-nya ke jumlah elemen dalam array tersebut dan mengembalikan penunjuk ke elemen pertama array.

COlePropertyPage::GetPageSite

Mendapatkan penunjuk ke antarmuka halaman IPropertyPageSite properti.

LPPROPERTYPAGESITE GetPageSite();

Tampilkan Nilai

Penunjuk ke antarmuka halaman IPropertyPageSite properti.

Keterangan

Kontrol dan kontainer bekerja sama sehingga pengguna dapat menelusuri dan mengedit properti kontrol. Kontrol menyediakan halaman properti, yang masing-masing adalah objek OLE yang memungkinkan pengguna mengedit sekumpulan properti terkait. Kontainer menyediakan bingkai properti yang menampilkan halaman properti. Untuk setiap halaman, bingkai properti menyediakan situs halaman, yang mendukung IPropertyPageSite antarmuka.

COlePropertyPage::IgnoreApply

Menentukan kontrol mana yang tidak mengaktifkan tombol Terapkan.

void IgnoreApply(UINT nID);

Parameter

Nid
ID kontrol yang akan diabaikan.

Keterangan

Tombol Terapkan halaman properti diaktifkan hanya ketika nilai kontrol halaman properti telah diubah. Gunakan fungsi ini untuk menentukan kontrol yang tidak menyebabkan tombol Terapkan diaktifkan saat nilainya berubah.

COlePropertyPage::IsModified

Menentukan apakah pengguna telah mengubah nilai apa pun di halaman properti.

BOOL IsModified();

Tampilkan Nilai

TRUE jika halaman properti telah dimodifikasi.

COlePropertyPage::OnEditProperty

Kerangka kerja memanggil fungsi ini ketika properti tertentu akan diedit.

virtual BOOL OnEditProperty(DISPID dispid);

Parameter

dispid
ID pengiriman properti yang sedang diedit.

Tampilkan Nilai

Implementasi default mengembalikan FALSE. Penimpaan fungsi ini harus mengembalikan TRUE.

Keterangan

Anda dapat mengambil alihnya untuk mengatur fokus ke kontrol yang sesuai pada halaman. Implementasi default tidak melakukan apa pun dan mengembalikan FALSE.

COlePropertyPage::OnHelp

Kerangka kerja memanggil fungsi ini ketika pengguna meminta bantuan online.

virtual BOOL OnHelp(LPCTSTR lpszHelpDir);

Parameter

lpszHelpDir
Direktori yang berisi file bantuan halaman properti.

Tampilkan Nilai

Implementasi default mengembalikan FALSE.

Keterangan

Ambil alih jika halaman properti Anda harus melakukan tindakan khusus saat pengguna mengakses bantuan. Implementasi default tidak melakukan apa pun dan mengembalikan FALSE, yang menginstruksikan kerangka kerja untuk memanggil WinHelp.

COlePropertyPage::OnInitDialog

Kerangka kerja memanggil fungsi ini saat dialog halaman properti diinisialisasi.

virtual BOOL OnInitDialog();

Tampilkan Nilai

Implementasi default mengembalikan FALSE.

Keterangan

Ambil alih jika ada tindakan khusus yang diperlukan saat dialog diinisialisasi. Implementasi default memanggil CDialog::OnInitDialog dan mengembalikan FALSE.

COlePropertyPage::OnObjectsChanged

Dipanggil oleh kerangka kerja ketika kontrol OLE lain, dengan properti baru, dipilih.

virtual void OnObjectsChanged();

Keterangan

Saat menampilkan properti kontrol OLE di lingkungan pengembang, kotak dialog tanpa mode digunakan untuk menampilkan halaman propertinya. Jika kontrol lain dipilih, sekumpulan halaman properti yang berbeda harus ditampilkan untuk kumpulan properti baru. Kerangka kerja memanggil fungsi ini untuk memberi tahu halaman properti perubahan.

Ambil alih fungsi ini untuk menerima pemberitahuan tindakan ini dan lakukan tindakan khusus apa pun.

COlePropertyPage::OnSetpageSite

Kerangka kerja memanggil fungsi ini ketika bingkai properti menyediakan situs halaman halaman properti.

virtual void OnSetPageSite();

Keterangan

Implementasi default memuat keterangan halaman dan mencoba menentukan ukuran halaman dari sumber daya dialog. Ambil alih fungsi ini jika halaman properti Anda memerlukan tindakan lebih lanjut; penimpaan Anda harus memanggil implementasi kelas dasar.

COlePropertyPage::SetControlStatus

Mengubah status kontrol halaman properti.

BOOL SetControlStatus(
    UINT nID,
    BOOL bDirty);

Parameter

Nid
Berisi ID kontrol halaman properti.

bDirty
Menentukan apakah bidang halaman properti telah dimodifikasi. Atur ke TRUE jika bidang telah dimodifikasi, FALSE jika belum dimodifikasi.

Tampilkan Nilai

TRUE, jika kontrol yang ditentukan telah ditetapkan; jika tidak FALSE.

Keterangan

Jika status kontrol halaman properti kotor ketika halaman properti ditutup atau tombol Terapkan dipilih, properti kontrol akan diperbarui dengan nilai yang sesuai.

COlePropertyPage::SetDialogResource

Mengatur sumber daya dialog halaman properti.

void SetDialogResource(HGLOBAL hDialog);

Parameter

hDialog
Tangani ke sumber daya dialog halaman properti.

COlePropertyPage::SetHelpInfo

Menentukan informasi tipsalat, nama file bantuan, dan konteks bantuan untuk halaman properti Anda.

void SetHelpInfo(
    LPCTSTR lpszDocString,
    LPCTSTR lpszHelpFile = NULL,
    DWORD dwHelpContext = 0);

Parameter

lpszDocString
String yang berisi informasi bantuan singkat untuk ditampilkan di bilah status atau lokasi lainnya.

lpszHelpFile
Nama file bantuan halaman properti.

dwHelpContext
Konteks bantuan untuk halaman properti.

COlePropertyPage::SetModifiedFlag

Menunjukkan apakah pengguna telah memodifikasi halaman properti.

void SetModifiedFlag(BOOL bModified = TRUE);

Parameter

bModified
Menentukan nilai baru untuk bendera yang dimodifikasi halaman properti.

COlePropertyPage::SetPageName

Mengatur nama halaman properti, yang biasanya akan ditampilkan bingkai properti pada tab halaman.

void SetPageName(LPCTSTR lpszPageName);

Parameter

lpszPageName
Penunjuk ke string yang berisi nama halaman properti.

Lihat juga

Sampel MFC CIRC3
TESTHELP Sampel MFC
Kelas CDialog
Bagan Hierarki
Kelas CDialog