Kelas CMFCRibbonButton

Kelas CMFCRibbonButton mengimplementasikan tombol yang bisa Anda posisikan pada elemen bilah pita seperti panel, Toolbar Akses Cepat, dan menu pop-up.

Untuk detail selengkapnya, lihat kode sumber yang terletak di folder VC\atlmfc\src\mfc dari penginstalan Visual Studio Anda.

Sintaks

class CMFCRibbonButton : public CMFCRibbonBaseElement

Anggota

Konstruktor Publik

Nama	Deskripsi
CMFCRibbonButton::CMFCRibbonButton	Membuat objek tombol pita.

Metode Publik

Nama	Deskripsi
CMFCRibbonButton::AddSubItem	Menambahkan item menu ke menu pop-up yang terkait dengan tombol .
CMFCRibbonButton::CanBeStretched	(Penimpaan CMFCRibbonBaseelement::CanBeStretched.)
CMFCRibbonButton::CleanUpSizes	(Penimpaan CMFCRibbonBaseElement::CleanUpSizes.)
CMFCRibbonButton::ClosePopupMenu	(Penimpaan CMFCRibbonBaseElement::ClosePopupMenu.)
CMFCRibbonButton::D rawBottomText
CMFCRibbonButton::D rawImage	(Penimpaan CMFCRibbonBaseElement::D rawImage.)
CMFCRibbonButton::D rawRibbonText
CMFCRibbonButton::FindSubItemIndexByID	Mengembalikan indeks item menu pop-up yang terkait dengan ID perintah yang ditentukan.
CMFCRibbonButton::GetCommandRect
CMFCRibbonButton::GetCompactSize	Mengembalikan ukuran ringkas elemen pita. (Penimpaan CMFCRibbonBaseElement::GetCompactSize.)
CMFCRibbonButton::GetIcon
CMFCRibbonButton::GetImageIndex	Mengembalikan indeks gambar yang terkait dengan tombol .
CMFCRibbonButton::GetImageSize	Mengembalikan ukuran gambar elemen pita. (Penimpaan CMFCRibbonBaseelement::GetImageSize.)
CMFCRibbonButton::GetIntermediateSize	Mengembalikan ukuran elemen pita dalam status menengahnya. (Penimpaan CMFCRibbonBaseElement::GetIntermediateSize.)
CMFCRibbonButton::GetMenu	Mengembalikan handel ke menu Windows yang ditetapkan ke tombol pita.
CMFCRibbonButton::GetMenuRect
CMFCRibbonButton::GetRegularSize	Mengembalikan ukuran reguler elemen pita. (Penimpaan CMFCRibbonBaseElement::GetRegularSize.)
CMFCRibbonButton::GetSubItems
CMFCRibbonButton::GetTextRowHeight
CMFCRibbonButton::GetToolTipText	Mengembalikan teks tipsalat elemen pita. (Penimpaan CMFCRibbonBaseElement::GetToolTipText.)
CMFCRibbonButton::HasCompactMode	Menentukan apakah elemen pita memiliki mode ringkas. (Penimpaan CMFCRibbonBaseElement::HasCompactMode.)
CMFCRibbonButton::HasIntermediateMode	Menentukan apakah elemen pita memiliki mode menengah. (Penimpaan CMFCRibbonBaseElement::HasIntermediateMode.)
CMFCRibbonButton::HasLargeMode	Menentukan apakah elemen pita memiliki mode besar. (Penimpaan CMFCRibbonBaseElement::HasLargeMode.)
CMFCRibbonButton::HasMenu	(Penimpaan CMFCRibbonBaseElement::HasMenu.)
CMFCRibbonButton::IsAlwaysDrawBorder
CMFCRibbonButton::IsAlwaysLargeImage	(Penimpaan CMFCRibbonBaseElement::IsAlwaysLargeImage.)
CMFCRibbonButton::IsApplicationButton
CMFCRibbonButton::IsCommandAreaHighlighted
CMFCRibbonButton::IsDefaultCommand	Menentukan apakah Anda telah mengaktifkan perintah default untuk tombol pita.
CMFCRibbonButton::IsDefaultPanelButton
CMFCRibbonButton::IsDrawTooltipImage
CMFCRibbonButton::IsLargeImage
CMFCRibbonButton::IsMenuAreaHighlighted
CMFCRibbonButton::IsMenuOnBottom
CMFCRibbonButton::IsPopupDefaultMenuLook
CMFCRibbonButton::IsRightAlignMenu	Menentukan apakah menu rata kanan.
CMFCRibbonButton::IsSingleLineText
CMFCRibbonButton::OnCalcTextSize	(Penimpaan CMFCRibbonBaseElement::OnCalcTextSize.)
CMFCRibbonButton::OnDrawBorder
CMFCRibbonButton::OnDraw	Dipanggil oleh kerangka kerja untuk menggambar elemen pita. (Penimpaan CMFCRibbonBaseElement::OnDraw.)
CMFCRibbonButton::OnFillBackground
CMFCRibbonButton::RemoveAllSubItems	Menghapus semua item menu dari menu pop-up.
CMFCRibbonButton::RemoveSubItem	Menghapus item menu dari menu pop-up.
CMFCRibbonButton::SetACCData	(Penimpaan CMFCRibbonBaseElement::SetACCData.)
CMFCRibbonButton::SetAlwaysLargeImage	Menentukan apakah tombol menampilkan gambar besar atau kecil saat pengguna menciutkan tombol.
CMFCRibbonButton::SetDefaultCommand	Mengaktifkan perintah default untuk tombol pita.
CMFCRibbonButton::SetDescription	Mengatur deskripsi untuk elemen pita. (Penimpaan CMFCRibbonBaseElement::SetDescription.)
CMFCRibbonButton::SetImageIndex	Menetapkan indeks ke gambar tombol.
CMFCRibbonButton::SetMenu	Menetapkan menu pop-up ke tombol pita.
CMFCRibbonButton::SetParentCategory	(Penimpaan CMFCRibbonBaseElement::SetParentCategory.)
CMFCRibbonButton::SetRightAlignMenu	Meratakan menu pop-up di sebelah kanan tombol.
CMFCRibbonButton::SetText	Mengatur teks untuk elemen pita. (Penimpaan CMFCRibbonBaseElement::SetText.)

Metode yang Dilindungi

Nama	Deskripsi
CMFCRibbonButton::OnClick	Dipanggil oleh kerangka kerja saat pengguna mengklik tombol .

Contoh

Contoh berikut menunjukkan cara menggunakan berbagai metode di CMFCRibbonButton kelas . Contoh memperlihatkan cara membuat objek CMFCRibbonButton kelas, menetapkan menu pop-up ke tombol pita, mengatur deskripsi tombol, menghapus item menu dari menu pop-up, dan meratakan menu pop-up ke tepi tombol.

strTemp.LoadString(IDS_RIBBON_STYLE);
// The first parameter is the command ID of the button.
// The third parameter is a zero-based index of the button's small image in the
// image list of the parent category.
// The fourth parameter is a zero-based index of the button's large image in the
// image list of the parent category.
CMFCRibbonButton *pVisualStyleButton = new CMFCRibbonButton(1, strTemp, -1, -1);

pVisualStyleButton->SetMenu(IDR_THEME_MENU, TRUE, TRUE);

strTemp.LoadString(IDS_RIBBON_STYLE_TIP);
pVisualStyleButton->SetToolTipText(strTemp);
strTemp.LoadString(IDS_RIBBON_STYLE_DESC);
pVisualStyleButton->SetDescription(strTemp);
pVisualStyleButton->RemoveSubItem(0);
pVisualStyleButton->SetRightAlignMenu(TRUE);

Keterangan

Untuk menggunakan tombol pita dalam aplikasi, buat objek tombol dan tambahkan ke panel pita yang sesuai.

CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"), // Panel name
    m_PanelIcons.ExtractIcon (0)); // Panel icon

// Create the first button ("Paste"):
CMFCRibbonButton* pPasteButton =
    new CMFCRibbonButton (ID_EDIT_PASTE, _T("Paste"), -1, 0);

// The third parameter (-1) disables small images for button.
// This button is always displayed with a large image
// Associate a pop-up menu with the "Paste" button:
pPasteButton->SetMenu (IDR_CONTEXT_MENU);

// Add buttons to the panel. These buttons have only small images.
pPanel->Add (new CMFCRibbonButton (ID_EDIT_CUT, _T("Cut"), 1));
pPanel->Add (new CMFCRibbonButton (ID_EDIT_COPY, _T("Copy"), 2));
pPanel->Add (new CMFCRibbonButton (ID_EDIT_PAINT, _T("Paint"), 9));

Hierarki Warisan

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

Persyaratan

Header: afxribbonbutton.h

CMFCRibbonButton::AddSubItem

Menambahkan item menu ke menu pop-up yang terkait dengan tombol .

void AddSubItem(
    CMFCRibbonBaseElement* pSubItem,
    int nIndex=-1);

Parameter

pSubItem
[di] Menentukan penunjuk ke elemen baru untuk ditambahkan.

nIndex
[di] Menentukan indeks untuk menambahkan elemen ke array item menu tombol; -1 untuk menambahkan elemen di akhir array item menu.

CMFCRibbonButton::CanBeStretched

virtual BOOL CanBeStretched();

Tampilkan Nilai

Keterangan

CMFCRibbonButton::CleanUpSizes

virtual void CleanUpSizes();

Keterangan

CMFCRibbonButton::ClosePopupMenu

virtual void ClosePopupMenu();

Keterangan

CMFCRibbonButton::CMFCRibbonButton

Membuat objek tombol pita.

CMFCRibbonButton(
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex=-1,
    int nLargeImageIndex=-1,
    BOOL bAlwaysShowDescription=FALSE);

CMFCRibbonButton(
    UINT nID,
    LPCTSTR lpszText,
    HICON hIcon,
    BOOL bAlwaysShowDescription=FALSE,
    HICON hIconSmall=NULL,
    BOOL bAutoDestroyIcon=FALSE,
    BOOL bAlphaBlendIcon=FALSE);

Parameter

Nid
[di] Menentukan ID perintah tombol.

lpszText
[di] Menentukan label teks tombol.

nSmallImageIndex
[di] Menentukan indeks berbasis nol dari gambar kecil tombol dalam daftar gambar kategori induk.

nLargeImageIndex
[di] Menentukan indeks berbasis nol dari gambar besar tombol dalam daftar gambar kategori induk.

hIcon
[di] Menentukan handel ke ikon yang digunakan aplikasi sebagai gambar tombol.

Contoh

Contoh berikut menunjukkan cara membuat CMFCRibbonButton objek.

strTemp.LoadString(IDS_RIBBON_CUT);
CMFCRibbonButton *butn = new CMFCRibbonButton(ID_EDIT_CUT, strTemp, 1);
butn->SetKeys(_T("k"));

CMFCRibbonButton::D rawBottomText

CSize DrawBottomText(
    CDC* pDC,
    BOOL bCalcOnly);

Parameter

[di] pDC
[di] bCalcOnly

Tampilkan Nilai

Keterangan

CMFCRibbonButton::D rawImage

virtual void DrawImage(
    CDC* pDC,
    RibbonImageType type,
    CRect rectImage);

Parameter

[di] pDC
[di] jenis
[di] rectImage

Keterangan

CMFCRibbonButton::D rawRibbonText

virtual int DrawRibbonText(
    CDC* pDC,
    const CString& strText,
    CRect rectText,
    UINT uiDTFlags,
    COLORREF clrText = (COLORREF)-1);

Parameter

[di] pDC
[di] strText
[di] rectText
[di] uiDTFlags
[di] clrText

Tampilkan Nilai

Keterangan

CMFCRibbonButton::FindSubItemIndexByID

Mengembalikan indeks item menu pop-up yang terkait dengan ID perintah yang ditentukan.

int FindSubItemIndexByID(UINT uiID) const;

Parameter

uiID
[di] Menentukan ID perintah item menu pop-up.

Tampilkan Nilai

Indeks berbasis nol dari sub-item yang terkait dengan uiID. -1 jika tidak ada sub-item tersebut.

CMFCRibbonButton::GetCommandRect

CRect GetCommandRect() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parameter

[di] pDC

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetIcon

HICON GetIcon(BOOL bLargeIcon = TRUE) const;

Parameter

[di] bLargeIcon

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetImageIndex

Mengembalikan indeks gambar yang terkait dengan tombol .

int GetImageIndex(BOOL bLargeImage) const;

Parameter

bLargeImage
[di] Jika TRUE, mengembalikan indeks gambar dalam daftar gambar yang berisi gambar besar; jika tidak, mengembalikan indeks gambar dalam daftar gambar yang berisi gambar kecil.

Tampilkan Nilai

Indeks gambar tombol dalam daftar gambar terkait.

CMFCRibbonButton::GetImageSize

virtual CSize GetImageSize(RibbonImageType type) const;

Parameter

[di] jenis

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetIntermediateSize

virtual CSize GetIntermediateSize(CDC* pDC);

Parameter

[di] pDC

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetMenu

Mengembalikan handel ke menu Windows yang ditetapkan ke tombol pita.

HMENU GetMenu() const;

Tampilkan Nilai

Handel ke menu Windows yang ditetapkan ke tombol; NULL jika tidak ada menu yang ditetapkan.

CMFCRibbonButton::GetMenuRect

CRect GetMenuRect() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parameter

[di] pDC

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetSubItems

const CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& GetSubItems() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetTextRowHeight

int GetTextRowHeight() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::GetToolTipText

virtual CString GetToolTipText() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::HasCompactMode

virtual BOOL HasCompactMode() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::HasIntermediateMode

virtual BOOL HasIntermediateMode() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::HasLargeMode

virtual BOOL HasLargeMode() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::HasMenu

virtual BOOL HasMenu() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsAlwaysDrawBorder

virtual BOOL IsAlwaysDrawBorder() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsAlwaysLargeImage

virtual BOOL IsAlwaysLargeImage() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsApplicationButton

virtual BOOL IsApplicationButton() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsCommandAreaHighlighted

virtual BOOL IsCommandAreaHighlighted() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsDefaultCommand

Menentukan apakah perintah default untuk tombol pita diaktifkan.

BOOL IsDefaultCommand() const;

Tampilkan Nilai

TRUE jika Anda telah mengaktifkan perintah default untuk tombol pita; FALSE jika tidak.

CMFCRibbonButton::IsDefaultPanelButton

virtual BOOL IsDefaultPanelButton() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsDrawTooltipImage

virtual BOOL IsDrawTooltipImage() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsLargeImage

BOOL IsLargeImage() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsMenuAreaHighlighted

virtual BOOL IsMenuAreaHighlighted() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsMenuOnBottom

BOOL IsMenuOnBottom() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsPopupDefaultMenuLook

virtual BOOL IsPopupDefaultMenuLook() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::IsRightAlignMenu

Menentukan apakah menu rata kanan.

BOOL IsRightAlignMenu() const;

Tampilkan Nilai

TRUE jika menu rata kanan; jika tidak FALSE.

CMFCRibbonButton::IsSingleLineText

BOOL IsSingleLineText() const;

Tampilkan Nilai

Keterangan

CMFCRibbonButton::OnCalcTextSize

virtual void OnCalcTextSize(CDC* pDC);

Parameter

[di] pDC

Keterangan

CMFCRibbonButton::OnClick

Dipanggil oleh kerangka kerja saat pengguna mengklik tombol .

virtual void OnClick(CPoint point);

Parameter

ujung
[di] Menentukan posisi klik mouse.

Keterangan

Ambil alih metode ini di kelas turunan jika Anda ingin menangani peristiwa ini.

CMFCRibbonButton::OnDraw

virtual void OnDraw(CDC* pDC);

Parameter

[di] pDC

Keterangan

CMFCRibbonButton::OnDrawBorder

virtual void OnDrawBorder(CDC* pDC);

Parameter

[di] pDC

Keterangan

CMFCRibbonButton::OnFillBackground

virtual COLORREF OnFillBackground(CDC* pDC);

Parameter

[di] pDC

Tampilkan Nilai

Keterangan

CMFCRibbonButton::RemoveAllSubItems

Menghapus semua item menu dari menu pop-up.

void RemoveAllSubItems();

CMFCRibbonButton::RemoveSubItem

Menghapus item menu dari menu pop-up.

BOOL RemoveSubItem(int nIndex);

Parameter

nIndex
[di] Menentukan indeks berbasis nol dari item menu yang ingin Anda hapus.

Tampilkan Nilai

TRUE jika item yang ditentukan telah berhasil dihapus; jika tidak, FALSE jika nIndex negatif atau melebihi jumlah item menu di menu pop-up.

CMFCRibbonButton::SetACCData

Mengatur data aksesibilitas untuk tombol pita.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Parameter

pParent
Jendela induk untuk elemen pita.

data
Data aksesibilitas untuk elemen pita.

Tampilkan Nilai

Mengembalikan TRUE jika berhasil; jika tidak FALSE.

Keterangan

CMFCRibbonButton::SetAlwaysLargeImage

Menentukan apakah tombol menampilkan gambar besar atau kecil saat pengguna menciutkan tombol.

void SetAlwaysLargeImage(BOOL bSet=TRUE);

Parameter

bSet
[di] Jika TRUE, tombol menampilkan gambar besar. Jika tidak, tombol menampilkan gambar kecil.

CMFCRibbonButton::SetDefaultCommand

Mengaktifkan perintah default untuk tombol pita.

void SetDefaultCommand(BOOL bSet=TRUE);

Parameter

bSet
[di] Jika TRUE, tombol dapat menjalankan perintah defaultnya. Jika FALSE, tombol tidak dapat menjalankan perintah defaultnya.

Keterangan

bSet hanya relevan ketika tombol memiliki menu. Jika bSet TRUE, tombol dapat menjalankan perintah defaultnya dan menu pop-up yang ditetapkan hanya muncul saat pengguna mengklik panah di tepi kanan tombol. Jika tidak, tombol tidak dapat menjalankan perintah defaultnya, dan menu pop-up muncul terlepas dari area tombol mana yang diklik pengguna.

CMFCRibbonButton::SetDescription

virtual void SetDescription(LPCTSTR lpszText);

Parameter

[di] lpszText

Keterangan

CMFCRibbonButton::SetImageIndex

Menetapkan indeks ke gambar tombol.

void SetImageIndex(
    int nIndex,
    BOOL bLargeImage);

Parameter

nIndex
[di] Menentukan indeks gambar.

bLargeImage
[di] Jika TRUE, indeks yang ditentukan mengacu pada daftar gambar besar. Jika tidak, indeks mengacu pada daftar gambar kecil.

CMFCRibbonButton::SetMenu

Menetapkan menu pop-up ke tombol pita.

void SetMenu(
    HMENU hMenu,
    BOOL bIsDefaultCommand=FALSE,
    BOOL bRightAlign=FALSE);

void SetMenu(
    UINT uiMenuResID,
    BOOL bIsDefaultCommand=FALSE,
    BOOL bRightAlign=FALSE);

Parameter

hMenu
Handel ke menu Windows.

bIsDefaultCommand
Jika TRUE, tombol dapat menjalankan perintah defaultnya; jika tidak, tombol menampilkan menu pop-up.

bRightAlign
Jika TRUE, menu rata kanan. Jika tidak, menu diratakan kiri.

uiMenuResID
ID sumber daya menu.

Keterangan

Saat aplikasi menetapkan menu ke tombol , tombol menampilkan panah di sisi kanannya. Jika bIsDefaultCommand true, menu hanya muncul saat pengguna mengklik panah. Jika pengguna mengklik tombol , perintah defaultnya akan dijalankan. Jika bIsDefaultCommand false, menu muncul dengan mengklik di mana saja pada tombol .

CMFCRibbonButton::SetParentCategory

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Parameter

[di] pParent

Keterangan

CMFCRibbonButton::SetRightAlignMenu

Meratakan menu pop-up ke tepi tombol.

void SetRightAlignMenu(BOOL bSet=TRUE);

Parameter

bSet
[di] Jika TRUE, menu rata kanan. Jika tidak, menu rata kiri

CMFCRibbonButton::SetText

virtual void SetText(LPCTSTR lpszText);

Parameter

[di] lpszText

Keterangan

Lihat juga

Bagan Hierarki
Kelas