Kelas CMFCPropertySheet

Kelas CMFCPropertySheet mendukung lembar properti di mana setiap halaman properti ditandai oleh tab halaman, tombol toolbar, simpul kontrol pohon, atau item daftar.

Sintaks

class CMFCPropertySheet : public CPropertySheet

Anggota

Konstruktor Publik

Nama	Deskripsi
CMFCPropertySheet::CMFCPropertySheet	Membuat CMFCPropertySheet objek.
CMFCPropertySheet::~CMFCPropertySheet	Destruktor.

Metode Publik

Nama	Deskripsi
CMFCPropertySheet::AddPage	Menambahkan halaman ke lembar properti.
CMFCPropertySheet::AddPageToTree	Menambahkan halaman properti baru ke kontrol pohon.
CMFCPropertySheet::AddTreeCategory	Menambahkan simpul baru ke kontrol pohon.
CMFCPropertySheet::EnablePageHeader	Mencadangkan ruang di bagian atas setiap halaman untuk menggambar header kustom.
CMFCPropertySheet::GetHeaderHeight	Mengambil tinggi header saat ini.
CMFCPropertySheet::GetLook	Mengambil nilai enumerasi yang menentukan tampilan lembar properti saat ini.
CMFCPropertySheet::GetNavBarWidth	Mencoba kembali lebar bilah navigasi dalam piksel.
CMFCPropertySheet::GetTab	Mengambil objek kontrol tab internal yang mendukung kontrol lembar properti saat ini.
CMFCPropertySheet::GetThisClass	Digunakan oleh kerangka kerja untuk mendapatkan penunjuk ke objek CRuntimeClass yang terkait dengan jenis kelas ini.
CMFCPropertySheet::InitNavigationControl	Menginisialisasi tampilan kontrol lembar properti saat ini.
CMFCPropertySheet::OnActivatePage	Dipanggil oleh kerangka kerja saat halaman properti diaktifkan.
CMFCPropertySheet::OnDrawPageHeader	Dipanggil oleh kerangka kerja untuk menggambar header halaman properti kustom.
CMFCPropertySheet::OnInitDialog	Menangani pesan WM_INITDIALOG. (Penimpaan CPropertySheet::OnInitDialog.)
CMFCPropertySheet::OnRemoveTreePage	Dipanggil oleh kerangka kerja untuk menghapus halaman properti dari kontrol pohon.
CMFCPropertySheet::PreTranslateMessage	Menerjemahkan pesan jendela sebelum dikirim ke fungsi Windows TranslateMessage dan DispatchMessage . (Mengambil alih CPropertySheet::PreTranslateMessage.)
CMFCPropertySheet::RemoveCategory	Menghapus simpul dari kontrol pohon.
CMFCPropertySheet::RemovePage	Menghapus halaman properti dari lembar properti.
CMFCPropertySheet::SetIconsList	Menentukan daftar gambar yang digunakan dalam kontrol navigasi panel Outlook.
CMFCPropertySheet::SetLook	Menentukan tampilan lembar properti.

Keterangan

Kelas CMFCPropertySheet mewakili lembar properti, juga dikenal sebagai kotak dialog tab. Kelas CMFCPropertySheet dapat menampilkan halaman properti dengan berbagai cara.

Lakukan langkah-langkah berikut untuk menggunakan CMFCPropertySheet kelas di aplikasi Anda:

1. Mendapatkan kelas dari CMFCPropertySheet kelas dan memberi nama kelas, misalnya, CMyPropertySheet.

2. Buat objek CMFCPropertyPage untuk setiap halaman properti.

3. Panggil metode CMFCPropertySheet::SetLook di konstruktor CMyPropertySheet. Parameter metode tersebut menentukan bahwa halaman properti harus ditampilkan baik sebagai tab di sepanjang bagian atas atau kiri lembar properti; tab dalam gaya lembar properti Microsoft OneNote; tombol pada kontrol toolbar Microsoft Outlook; node pada kontrol pohon; atau sebagai daftar item di sisi kiri lembar properti.

4. Jika Anda membuat lembar properti dalam gaya toolbar Microsoft Outlook, panggil metode CMFCPropertySheet::SetIconsList untuk mengaitkan daftar gambar bersama-sama dengan halaman properti.

5. Panggil metode CMFCPropertySheet::AddPage untuk setiap halaman properti.

6. Buat CMFCPropertySheet kontrol dan panggil metodenya DoModal .

Ilustrasi

Ilustrasi berikut ini menggambarkan lembar properti yang berada dalam gaya toolbar Microsoft Outlook yang disematkan. Toolbar Outlook muncul di sisi kiri lembar properti.

Ilustrasi berikut menggambarkan lembar properti yang berisi objek CMFCPropertyGridCtrl Class . Objek tersebut adalah lembar properti dalam gaya lembar properti kontrol umum standar.

Ilustrasi berikut menggambarkan lembar properti yang berada dalam gaya kontrol pohon.

Hierarki Warisan

CObject

CCmdTarget

CWnd

CPropertySheet

CMFCPropertySheet

Persyaratan

Header: afxpropertysheet.h

CMFCPropertySheet::AddPage

Menambahkan halaman ke lembar properti.

void AddPage(CPropertyPage* pPage);

Parameter

pPage
[di] Penunjuk ke objek halaman. Parameter ini tidak boleh NULL.

Keterangan

Metode ini menambahkan halaman properti yang ditentukan sebagai tab paling kanan dalam lembar properti. Oleh karena itu, gunakan metode ini untuk menambahkan halaman dalam urutan kiri ke kanan.

Jika lembar properti berada dalam gaya Microsoft Outlook, kerangka kerja menampilkan daftar tombol navigasi di sebelah kiri lembar properti. Setelah metode ini menambahkan halaman properti, metode menambahkan tombol yang sesuai ke daftar. Untuk menampilkan halaman properti, klik tombol yang sesuai. Untuk informasi selengkapnya tentang gaya lembar properti, lihat CMFCPropertySheet::SetLook.

CMFCPropertySheet::AddPageToTree

Menambahkan halaman properti baru ke kontrol pohon.

void AddPageToTree(
    CMFCPropertySheetCategoryInfo* pCategory,
    CMFCPropertyPage* pPage,
    int nIconNum=-1,
    int nSelIconNum=-1);

Parameter

pCategory
[di] Penunjuk ke simpul pohon induk, atau NULL untuk mengaitkan halaman yang ditentukan dengan simpul tingkat atas. Panggil metode CMFCPropertySheet::AddTreeCategory untuk mendapatkan pointer ini.

pPage
[di] Penunjuk ke objek halaman properti.

nIconNum
[di] Indeks berbasis nol ikon, atau -1 jika tidak ada ikon yang digunakan. Ikon ditampilkan di samping halaman properti kontrol pohon saat halaman tidak dipilih. Nilai defaultnya adalah -1.

nSelIconNum
[di] Indeks berbasis nol ikon, atau -1 jika tidak ada ikon yang digunakan. Ikon ditampilkan di samping halaman properti kontrol pohon saat halaman dipilih. Nilai defaultnya adalah -1.

Keterangan

Metode ini menambahkan halaman properti sebagai daun kontrol pohon. Untuk menambahkan halaman properti, buat CMFCPropertySheet objek, panggil metode CMFCPropertySheet::SetLook dengan parameter tampilan diatur ke CMFCPropertySheet::PropSheetLook_Tree, lalu gunakan metode ini untuk menambahkan halaman properti.

CMFCPropertySheet::AddTreeCategory

Menambahkan simpul baru ke kontrol pohon.

CMFCPropertySheetCategoryInfo* AddTreeCategory(
    LPCTSTR lpszLabel,
    int nIconNum=-1,
    int nSelectedIconNum=-1,
    const CMFCPropertySheetCategoryInfo* pParentCategory=NULL);

Parameter

lpszLabel
[di] Nama simpul.

nIconNum
[di] Indeks berbasis nol ikon, atau -1 jika tidak ada ikon yang digunakan. Ikon ditampilkan di samping halaman properti kontrol pohon saat halaman tidak dipilih. Nilai defaultnya adalah -1.

nSelectedIconNum
[di] Indeks berbasis nol ikon, atau -1 jika tidak ada ikon yang digunakan. Ikon ditampilkan di samping halaman properti kontrol pohon saat halaman dipilih. Nilai defaultnya adalah -1.

pParentCategory
[di] Penunjuk ke simpul pohon induk, atau NULL untuk mengaitkan halaman yang ditentukan dengan simpul tingkat atas. Atur parameter ini dengan metode CMFCPropertySheet::AddTreeCategory .

Tampilkan Nilai

Penunjuk ke simpul baru dalam kontrol pohon.

Keterangan

Gunakan metode ini untuk menambahkan simpul baru, yang juga disebut sebagai kategori, ke kontrol pohon. Untuk menambahkan simpul, buat CMFCPropertySheet objek, panggil metode CMFCPropertySheet::SetLook dengan parameter tampilan diatur ke CMFCPropertySheet::PropSheetLook_Tree, lalu gunakan metode ini untuk menambahkan simpul.

Gunakan nilai pengembalian metode ini dalam panggilan berikutnya ke CMFCPropertySheet::AddPageToTree dan CMFCPropertySheet::AddTreeCategory.

CMFCPropertySheet::CMFCPropertySheet

Membuat CMFCPropertySheet objek.

CMFCPropertySheet(
    UINT nIDCaption,
    CWnd* pParentWnd=NULL,
    UINT iSelectPage=0);

CMFCPropertySheet(
    LPCTSTR pszCaption,
    CWnd* pParentWnd=NULL,
    UINT iSelectPage=0);

Parameter

pszCaption
[di] String yang berisi keterangan lembar properti. Tidak boleh NULL.

nIDCaption
[di] ID sumber daya yang berisi keterangan lembar properti.

pParentWnd
[di] Penunjuk ke jendela induk lembar properti, atau NULL jika jendela induk adalah jendela utama aplikasi. Nilai defaultnya adalah NULL.

iSelectPage
[di] Indeks berbasis nol dari halaman properti atas. Nilai default adalah 0.

Keterangan

Untuk informasi selengkapnya, lihat parameter untuk konstruktor CPropertySheet::CPropertySheet .

CMFCPropertySheet::EnablePageHeader

Mencadangkan ruang di bagian atas setiap halaman untuk menggambar header kustom.

void EnablePageHeader(int nHeaderHeight);

Parameter

nHeaderHeight
[di] Tinggi header, dalam piksel.

Keterangan

Untuk menggunakan nilai parameter nHeaderHeight untuk menggambar header kustom, ambil alih metode CMFCPropertySheet::OnDrawPageHeader .

CMFCPropertySheet::GetHeaderHeight

Mengambil tinggi header saat ini.

int GetHeaderHeight() const;

Tampilkan Nilai

Tinggi header, dalam piksel.

Keterangan

Panggil metode CMFCPropertySheet::EnablePageHeader sebelum Anda memanggil metode ini.

CMFCPropertySheet::GetLook

Mengambil nilai enumerasi yang menentukan tampilan lembar properti saat ini.

PropSheetLook GetLook() const;

Tampilkan Nilai

Salah satu nilai enumerasi yang menentukan tampilan lembar properti. Untuk daftar nilai yang mungkin, lihat tabel enumerasi di bagian Keterangan CMFCPropertySheet ::SetLook.

CMFCPropertySheet::GetNavBarWidth

Mendapatkan lebar bilah navigasi.

int GetNavBarWidth() const;

Tampilkan Nilai

Lebar bilah navigasi dalam piksel.

CMFCPropertySheet::GetTab

Mengambil objek kontrol tab internal yang mendukung kontrol lembar properti saat ini.

CMFCTabCtrl& GetTab() const;

Tampilkan Nilai

Objek kontrol tab internal.

Keterangan

Anda dapat mengatur lembar properti sehingga muncul dalam gaya yang berbeda, seperti kontrol pohon, daftar tombol navigasi, atau sekumpulan halaman bertab.

Sebelum Anda memanggil metode ini, panggil metode CMFCPropertySheet::SetLook untuk mengatur tampilan kontrol lembar properti. Kemudian panggil metode CMFCPropertySheet::InitNavigationControl untuk menginisialisasi objek kontrol tab internal. Gunakan metode ini untuk mengambil objek kontrol tab lalu gunakan objek tersebut untuk bekerja dengan tab pada lembar properti.

Metode ini menegaskan dalam mode debug jika kontrol lembar properti tidak diatur untuk muncul dalam gaya Microsoft OneNote.

CMFCPropertySheet::InitNavigationControl

Menginisialisasi tampilan kontrol lembar properti saat ini.

virtual CWnd* InitNavigationControl();

Tampilkan Nilai

Penunjuk ke jendela kontrol lembar properti.

Keterangan

Kontrol lembar properti dapat muncul dalam beberapa formulir berbeda, seperti sekumpulan halaman bertab, kontrol pohon, atau daftar tombol navigasi. Gunakan metode CMFCPropertySheet::SetLook untuk menentukan tampilan kontrol lembar properti.

CMFCPropertySheet::OnActivatePage

Dipanggil oleh kerangka kerja saat halaman properti diaktifkan.

virtual void OnActivatePage(CPropertyPage* pPage);

Parameter

pPage
[di] Penunjuk ke objek halaman properti yang mewakili halaman properti yang diaktifkan.

Keterangan

Secara default, metode ini memastikan bahwa halaman properti yang diaktifkan digulir ke tampilan. Jika gaya lembar properti saat ini berisi panel Microsoft Outlook, metode ini mengatur tombol Outlook terkait ke status dicentang.

CMFCPropertySheet::OnDrawPageHeader

Dipanggil oleh kerangka kerja untuk menggambar header untuk halaman properti kustom.

virtual void OnDrawPageHeader(
    CDC* pDC,
    int nPage,
    CRect rectHeader);

Parameter

pDC
[di] Penunjuk ke konteks perangkat.

nPage
[di] Nomor halaman properti berbasis nol.

rectHeader
[di] Persegi panjang pembatas yang menentukan tempat untuk menggambar header.

Keterangan

Secara default, metode ini tidak melakukan apa pun. Jika Anda mengambil alih metode ini, panggil metode CMFCPropertySheet::EnablePageHeader sebelum kerangka kerja memanggil metode ini.

CMFCPropertySheet::OnRemoveTreePage

Dipanggil oleh kerangka kerja untuk menghapus halaman properti dari kontrol pohon.

virtual BOOL OnRemoveTreePage(CPropertyPage* pPage);

Parameter

pPage
[di] Penunjuk ke objek halaman properti yang mewakili halaman properti untuk dihapus.

Tampilkan Nilai

TRUE jika metode ini berhasil; jika tidak, FALSE.

CMFCPropertySheet::RemoveCategory

Menghapus simpul dari kontrol pohon.

void RemoveCategory(CMFCPropertySheetCategoryInfo* pCategory);

Parameter

pCategory
[di] Penunjuk ke kategori (simpul) untuk dihapus.

Keterangan

Gunakan metode ini untuk menghapus simpul, yang juga disebut sebagai kategori, dari kontrol pohon. Gunakan metode CMFCPropertySheet::AddTreeCategory untuk menambahkan simpul ke kontrol pohon.

CMFCPropertySheet::RemovePage

Menghapus halaman properti dari lembar properti.

void RemovePage(CPropertyPage* pPage);
void RemovePage(int nPage);

Parameter

pPage
[di] Penunjuk ke objek halaman properti yang mewakili halaman properti untuk dihapus. Tidak boleh NULL.

nPage
[di] Indeks berbasis nol halaman yang akan dihapus.

Keterangan

Metode ini menghapus halaman properti yang ditentukan dan menghancurkan jendela terkait. Objek halaman properti yang ditentukan parameter pPage tidak dihancurkan sampai jendela CMFCPropertySheet ditutup.

CMFCPropertySheet::SetIconsList

Menentukan daftar gambar yang digunakan dalam kontrol navigasi panel Outlook.

BOOL SetIconsList(
    UINT uiImageListResID,
    int cx,
    COLORREF clrTransparent=RGB(255, 0, 255));
void SetIconsList(HIMAGELIST hIcons);

Parameter

uiImageListResID
[di] ID sumber daya daftar gambar.

cx
[di] Lebar, dalam piksel, ikon dalam daftar gambar.

clrTransparent
[di] Warna gambar transparan. Bagian gambar yang berwarna ini akan transparan. Nilai defaultnya adalah magenta warna, RGB(255,0,255).

hIcons
[di] Handel ke daftar gambar yang sudah ada.

Tampilkan Nilai

Dalam sintaks overload metode pertama, TRUE jika metode ini berhasil; jika tidak, FALSE.

Keterangan

Jika lembar properti dalam gaya Microsoft Outlook, kerangka kerja menampilkan daftar tombol navigasi, yang disebut kontrol panel Outlook, di sebelah kiri lembar properti. Gunakan metode ini untuk mengatur daftar gambar yang akan digunakan oleh kontrol panel Outlook.

Untuk informasi selengkapnya tentang metode yang mendukung metode ini, lihat CImageList::Create dan CImageList::Add. Untuk informasi selengkapnya tentang cara mengatur gaya lembar properti, lihat CMFCPropertySheet::SetLook.

CMFCPropertySheet::SetLook

Menentukan tampilan lembar properti.

void SetLook(
    PropSheetLook look,
    int nNavControlWidth=100);

Parameter

Lihat
[di] Salah satu nilai enumerasi yang menentukan tampilan lembar properti. Gaya default untuk lembar properti adalah CMFCPropertySheet::PropSheetLook_Tabs. Untuk informasi selengkapnya, lihat tabel di bagian Keterangan dari topik ini.

nNavControlWidth
[di] Lebar kontrol navigasi, dalam piksel. Nilai default adalah 100.

Keterangan

Untuk menampilkan lembar properti dalam gaya selain default, panggil metode ini sebelum Anda membuat jendela lembar properti.

Tabel berikut mencantumkan nilai enumerasi yang dapat ditentukan dalam parameter tampilan .

Nilai	Deskripsi
CMFCPropertySheet::PropSheetLook_Tabs	(Default) Menampilkan tab untuk setiap halaman properti. Tab ditampilkan di bagian atas lembar properti dan ditumpuk jika ada lebih banyak tab daripada yang akan pas dalam satu baris.
CMFCPropertySheet::PropSheetLook_OutlookBar	Menampilkan daftar tombol navigasi, dalam gaya bilah Microsoft Outlook, di sisi kiri lembar properti. Setiap tombol dalam daftar sesuai dengan halaman properti. Kerangka kerja menampilkan panah gulir jika ada lebih banyak tombol daripada yang akan pas di area daftar yang terlihat.
CMFCPropertySheet::PropSheetLook_Tree	Menampilkan kontrol pohon di sisi kiri lembar properti. Setiap simpul induk atau anak dari kontrol pohon sesuai dengan halaman properti. Kerangka kerja menampilkan panah gulir jika ada lebih banyak simpul daripada yang akan pas di area kontrol pohon yang terlihat.
CMFCPropertySheet::PropSheetLook_OneNoteTabs	Menampilkan tab, dalam gaya Microsoft OneNote, untuk setiap halaman properti. Kerangka kerja menampilkan tab di bagian atas lembar properti dan panah gulir jika ada lebih banyak tab daripada yang akan pas dalam satu baris.
CMFCPropertySheet::PropSheetLook_List	Menampilkan daftar di sisi kiri lembar properti. Setiap item daftar sesuai dengan halaman properti. Kerangka kerja menampilkan panah gulir jika ada lebih banyak item daftar daripada yang akan pas di area daftar yang terlihat.

Lihat juga

Bagan Hierarki
Kelas
Kelas CMFCPropertyPage
Kelas CMFCOutlookBar