Share via


CMFCRibbonButton-klasse

Opmerking

De Microsoft Foundation Classes-bibliotheek (MFC) wordt nog steeds ondersteund. We voegen echter geen functies meer toe of werken de documentatie bij.

De CMFCRibbonButton klasse implementeert knoppen die u op lintbalkelementen kunt plaatsen, zoals deelvensters, werkbalken snelle toegang en snelmenu's.

Zie de broncode in de map VC\atlmfc\src\mfc van uw Visual Studio-installatie voor meer informatie.

Syntaxis

class CMFCRibbonButton : public CMFCRibbonBaseElement

Leden

Openbare constructors

Naam Description
CMFCRibbonButton::CMFCRibbonButton Maakt een lintknopobject.

Openbare methoden

Naam Description
CMFCRibbonButton::AddSubItem Hiermee voegt u een menu-item toe aan het snelmenu dat aan de knop is gekoppeld.
CMFCRibbonButton::CanBeStretched (Overschrijft CMFCRibbonBaseElement::CanBeStretched.)
CMFCRibbonButton::CleanUpSizes (Overschrijft CMFCRibbonBaseElement::CleanUpSizes.)
CMFCRibbonButton::ClosePopupMenu (Overschrijft CMFCRibbonBaseElement::ClosePopupMenu.)
CMFCRibbonButton::D rawBottomText
CMFCRibbonButton::D rawImage (Overschrijft CMFCRibbonBaseElement::D rawImage.)
CMFCRibbonButton::D rawRibbonText
CMFCRibbonButton::FindSubItemIndexByID Retourneert de index van een snelmenu-item dat is gekoppeld aan de opgegeven opdracht-id.
CMFCRibbonButton::GetCommandRect
CMFCRibbonButton::GetCompactSize Retourneert de compacte grootte van het lintelement. (Overschrijft CMFCRibbonBaseElement::GetCompactSize.)
CMFCRibbonButton::GetIcon
CMFCRibbonButton::GetImageIndex Retourneert de index van de afbeelding die is gekoppeld aan de knop.
CMFCRibbonButton::GetImageSize Retourneert de afbeeldingsgrootte van het lintelement. (Overschrijft CMFCRibbonBaseElement::GetImageSize.)
CMFCRibbonButton::GetIntermediateSize Retourneert de grootte van het lintelement in de tussenliggende status. (Overschrijft CMFCRibbonBaseElement::GetIntermediateSize.)
CMFCRibbonButton::GetMenu Hiermee wordt een ingang geretourneerd naar een Windows-menu dat is toegewezen aan de lintknop.
CMFCRibbonButton::GetMenuRect
CMFCRibbonButton::GetRegularSize Retourneert de normale grootte van het lintelement. (Overschrijft CMFCRibbonBaseElement::GetRegularSize.)
CMFCRibbonButton::GetSubItems
CMFCRibbonButton::GetTextRowHeight
CMFCRibbonButton::GetToolTipText Hiermee wordt knopinfotekst van het lintelement geretourneerd. (Overschrijft CMFCRibbonBaseElement::GetToolTipText.)
CMFCRibbonButton::HasCompactMode Hiermee geeft u op of het lintelement een compacte modus heeft. (Overschrijft CMFCRibbonBaseElement::HasCompactMode.)
CMFCRibbonButton::HasIntermediateMode Hiermee geeft u op of het lintelement een tussenliggende modus heeft. (Overschrijft CMFCRibbonBaseElement::HasIntermediateMode.)
CMFCRibbonButton::HasLargeMode Bepaalt of het lintelement een grote modus heeft. (Overschrijft CMFCRibbonBaseElement::HasLargeMode.)
CMFCRibbonButton::HasMenu (Overschrijft CMFCRibbonBaseElement::HasMenu.)
CMFCRibbonButton::IsAlwaysDrawBorder
CMFCRibbonButton::IsAlwaysLargeImage (Overschrijft CMFCRibbonBaseElement::IsAlwaysLargeImage.)
CMFCRibbonButton::IsApplicationButton
CMFCRibbonButton::IsCommandAreaHighlighted
CMFCRibbonButton::IsDefaultCommand Bepaalt of u de standaardopdracht voor een lintknop hebt ingeschakeld.
CMFCRibbonButton::IsDefaultPanelButton
CMFCRibbonButton::IsDrawTooltipImage
CMFCRibbonButton::IsLargeImage
CMFCRibbonButton::IsMenuAreaHighlighted
CMFCRibbonButton::IsMenuOnBottom
CMFCRibbonButton::IsPopupDefaultMenuLook
CMFCRibbonButton::IsRightAlignMenu Bepaalt of het menu rechts is uitgelijnd.
CMFCRibbonButton::IsSingleLineText
CMFCRibbonButton::OnCalcTextsize (Overschrijft CMFCRibbonBaseElement::OnCalcTextSize.)
CMFCRibbonButton::OnDrawBorder
CMFCRibbonButton::OnDraw Aangeroepen door het framework om het lintelement te tekenen. (Overschrijft CMFCRibbonBaseElement::OnDraw.)
CMFCRibbonButton::OnFillBackground
CMFCRibbonButton::RemoveAllSubItems Hiermee verwijdert u alle menu-items uit het snelmenu.
CMFCRibbonButton::RemoveSubItem Hiermee verwijdert u een menu-item uit het snelmenu.
CMFCRibbonButton::SetACCData (Overschrijft CMFCRibbonBaseElement::SetACCData.)
CMFCRibbonButton::SetAlwaysLargeImage Hiermee geeft u op of de knop een grote of een kleine afbeelding weergeeft wanneer de gebruiker de knop samenvouwen.
CMFCRibbonButton::SetDefaultCommand Hiermee schakelt u de standaardopdracht voor de lintknop in.
CMFCRibbonButton::SetDescription Hiermee stelt u de beschrijving voor het lintelement in. (Overschrijft CMFCRibbonBaseElement::SetDescription.)
CMFCRibbonButton::SetImageIndex Hiermee wordt een index toegewezen aan de afbeelding van de knop.
CMFCRibbonButton::SetMenu Hiermee wordt een snelmenu toegewezen aan de lintknop.
CMFCRibbonButton::SetParentCategory (Overschrijft CMFCRibbonBaseElement::SetParentCategory.)
CMFCRibbonButton::SetRightAlignMenu Hiermee wordt het snelmenu rechts van de knop uitgelijnd.
CMFCRibbonButton::SetText Hiermee stelt u de tekst voor het lintelement in. (Overschrijft CMFCRibbonBaseElement::SetText.)

Beveiligde methoden

Naam Description
CMFCRibbonButton::OnClick Aangeroepen door het framework wanneer de gebruiker op de knop klikt.

Example

In het volgende voorbeeld ziet u hoe u de verschillende methoden in de CMFCRibbonButton klasse gebruikt. In het voorbeeld ziet u hoe u een object van de CMFCRibbonButton klasse maakt, een snelmenu toewijst aan de lintknop, de beschrijving van de knop instelt, een menu-item verwijdert uit het snelmenu en het snelmenu rechts uitlijnt op de rand van de knop.

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);

Opmerkingen

Als u een lintknop in een toepassing wilt gebruiken, maakt u het knopobject en voegt u het toe aan het desbetreffende lintvenster.

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));

Overnamehiƫrarchie

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

Requirements

Koptekst: afxribbonbutton.h

CMFCRibbonButton::AddSubItem

Hiermee voegt u een menu-item toe aan het snelmenu dat aan de knop is gekoppeld.

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

Parameterwaarden

pSubItem
[in] Hiermee geeft u een aanwijzer naar het nieuwe element dat u wilt toevoegen.

nIndex
[in] Hiermee geeft u de index waarop het element moet worden toegevoegd aan de matrix met menu-items van de knop; -1 het element aan het einde van de matrix met menu-items toevoegen.

CMFCRibbonButton::CanBeStretched

virtual BOOL CanBeStretched();

Retourwaarde

Opmerkingen

CMFCRibbonButton::CleanUpSizes

virtual void CleanUpSizes();

Opmerkingen

CMFCRibbonButton::ClosePopupMenu

virtual void ClosePopupMenu();

Opmerkingen

CMFCRibbonButton::CMFCRibbonButton

Maakt een lintknopobject.

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);

Parameterwaarden

nID
[in] Hiermee geeft u de opdracht-id van de knop.

lpszText
[in] Hiermee geeft u het tekstlabel van de knop.

nSmallImageIndex
[in] Hiermee geeft u een op nul gebaseerde index op van de kleine afbeelding van de knop in de lijst met afbeeldingen van de bovenliggende categorie.

nLargeImageIndex
[in] Hiermee geeft u een op nul gebaseerde index op van de grote afbeelding van de knop in de lijst met afbeeldingen van de bovenliggende categorie.

hIcon
[in] Hiermee geeft u een ingang op voor het pictogram dat de toepassing gebruikt als de afbeelding van de knop.

Example

In het volgende voorbeeld ziet u hoe u een CMFCRibbonButton object maakt.

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);

Parameterwaarden

[in] Pdc
[in] bCalcOnly

Retourwaarde

Opmerkingen

CMFCRibbonButton::D rawImage

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

Parameterwaarden

[in] Pdc
[in] Type
[in] rectImage

Opmerkingen

CMFCRibbonButton::D rawRibbonText

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

Parameterwaarden

[in] Pdc
[in] strText
[in] rectText
[in] uiDTFlags
[in] clrText

Retourwaarde

Opmerkingen

CMFCRibbonButton::FindSubItemIndexByID

Retourneert de index van een snelmenu-item dat is gekoppeld aan de opgegeven opdracht-id.

int FindSubItemIndexByID(UINT uiID) const;

Parameterwaarden

uiID
[in] Hiermee geeft u de opdracht-id van de pop-upmenu-item.

Retourwaarde

De op nul gebaseerde index van het subitem dat is gekoppeld aan de uiID. -1 als er geen subitem is.

CMFCRibbonButton::GetCommandRect

CRect GetCommandRect() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parameterwaarden

[in] Pdc

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetIcon

HICON GetIcon(BOOL bLargeIcon = TRUE) const;

Parameterwaarden

[in] bLargeIcon

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetImageIndex

Retourneert de index van de afbeelding die is gekoppeld aan de knop.

int GetImageIndex(BOOL bLargeImage) const;

Parameterwaarden

bLargeImage
[in] Als WAAR is, retourneert u de afbeeldingsindex in de lijst met afbeeldingen die de grote afbeeldingen bevat; retourneert anders de afbeeldingsindex in de lijst met afbeeldingen die de kleine afbeeldingen bevat.

Retourwaarde

De index van de afbeelding van de knop in de bijbehorende lijst met afbeeldingen.

CMFCRibbonButton::GetImageSize

virtual CSize GetImageSize(RibbonImageType type) const;

Parameterwaarden

[in] Type

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetIntermediateSize

virtual CSize GetIntermediateSize(CDC* pDC);

Parameterwaarden

[in] Pdc

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetMenu

Hiermee wordt een ingang geretourneerd naar een Windows-menu dat is toegewezen aan de lintknop.

HMENU GetMenu() const;

Retourwaarde

Een ingang aan een Windows-menu dat is toegewezen aan de knop; NULL als er geen menu is toegewezen.

CMFCRibbonButton::GetMenuRect

CRect GetMenuRect() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parameterwaarden

[in] Pdc

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetSubItems

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

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetTextRowHeight

int GetTextRowHeight() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::GetToolTipText

virtual CString GetToolTipText() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::HasCompactMode

virtual BOOL HasCompactMode() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::HasIntermediateMode

virtual BOOL HasIntermediateMode() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::HasLargeMode

virtual BOOL HasLargeMode() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::HasMenu

virtual BOOL HasMenu() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsAlwaysDrawBorder

virtual BOOL IsAlwaysDrawBorder() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsAlwaysLargeImage

virtual BOOL IsAlwaysLargeImage() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsApplicationButton

virtual BOOL IsApplicationButton() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsCommandAreaHighlighted

virtual BOOL IsCommandAreaHighlighted() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsDefaultCommand

Hiermee geeft u op of de standaardopdracht voor een lintknop is ingeschakeld.

BOOL IsDefaultCommand() const;

Retourwaarde

WAAR als u de standaardopdracht voor een lintknop hebt ingeschakeld; ANDERS ONWAAR.

CMFCRibbonButton::IsDefaultPanelButton

virtual BOOL IsDefaultPanelButton() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsDrawTooltipImage

virtual BOOL IsDrawTooltipImage() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsLargeImage

BOOL IsLargeImage() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsMenuAreaHighlighted

virtual BOOL IsMenuAreaHighlighted() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsMenuOnBottom

BOOL IsMenuOnBottom() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsPopupDefaultMenuLook

virtual BOOL IsPopupDefaultMenuLook() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::IsRightAlignMenu

Hiermee geeft u op of het menu rechts is uitgelijnd.

BOOL IsRightAlignMenu() const;

Retourwaarde

WAAR als het menu rechts is uitgelijnd; anders ONWAAR.

CMFCRibbonButton::IsSingleLineText

BOOL IsSingleLineText() const;

Retourwaarde

Opmerkingen

CMFCRibbonButton::OnCalcTextsize

virtual void OnCalcTextSize(CDC* pDC);

Parameterwaarden

[in] Pdc

Opmerkingen

CMFCRibbonButton::OnClick

Aangeroepen door het framework wanneer de gebruiker op de knop klikt.

virtual void OnClick(CPoint point);

Parameterwaarden

Punt
[in] Hiermee geeft u de positie van de muisklik.

Opmerkingen

Overschrijf deze methode in een afgeleide klasse als u deze gebeurtenis wilt afhandelen.

CMFCRibbonButton::OnDraw

virtual void OnDraw(CDC* pDC);

Parameterwaarden

[in] Pdc

Opmerkingen

CMFCRibbonButton::OnDrawBorder

virtual void OnDrawBorder(CDC* pDC);

Parameterwaarden

[in] Pdc

Opmerkingen

CMFCRibbonButton::OnFillBackground

virtual COLORREF OnFillBackground(CDC* pDC);

Parameterwaarden

[in] Pdc

Retourwaarde

Opmerkingen

CMFCRibbonButton::RemoveAllSubItems

Hiermee verwijdert u alle menu-items uit het snelmenu.

void RemoveAllSubItems();

CMFCRibbonButton::RemoveSubItem

Hiermee verwijdert u een menu-item uit het snelmenu.

BOOL RemoveSubItem(int nIndex);

Parameterwaarden

nIndex
[in] Hiermee geeft u de op nul gebaseerde index op van het menu-item dat u wilt verwijderen.

Retourwaarde

WAAR als het opgegeven item is verwijderd; anders ONWAAR als nIndex negatief is of het aantal menu-items in het snelmenu overschrijdt.

CMFCRibbonButton::SetACCData

Hiermee stelt u de toegankelijkheidsgegevens voor de lintknop in.

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

Parameterwaarden

pParent
Het bovenliggende venster voor het lintelement.

gegevens
De toegankelijkheidsgegevens voor het lintelement.

Retourwaarde

Retourneert WAAR als het lukt; anders ONWAAR.

Opmerkingen

CMFCRibbonButton::SetAlwaysLargeImage

Hiermee geeft u op of de knop een grote of een kleine afbeelding weergeeft wanneer de gebruiker de knop samenvouwen.

void SetAlwaysLargeImage(BOOL bSet=TRUE);

Parameterwaarden

bSet
[in] Als WAAR is, wordt op de knop een grote afbeelding weergegeven. Anders wordt op de knop een kleine afbeelding weergegeven.

CMFCRibbonButton::SetDefaultCommand

Hiermee schakelt u de standaardopdracht voor de lintknop in.

void SetDefaultCommand(BOOL bSet=TRUE);

Parameterwaarden

bSet
[in] Als WAAR is, kan de knop de standaardopdracht uitvoeren. Als ONWAAR is, kan de knop de standaardopdracht niet uitvoeren.

Opmerkingen

bSet is alleen relevant wanneer de knop een menu heeft. Als bSet TRUE is, kan de knop de standaardopdracht uitvoeren en wordt het toegewezen snelmenu alleen weergegeven wanneer een gebruiker op de pijl rechts van de knop klikt. Anders kan de knop de standaardopdracht niet uitvoeren en wordt het snelmenu weergegeven, ongeacht het gebied van de knop waarop de gebruiker klikt.

CMFCRibbonButton::SetDescription

virtual void SetDescription(LPCTSTR lpszText);

Parameterwaarden

[in] lpszText

Opmerkingen

CMFCRibbonButton::SetImageIndex

Hiermee wordt een index toegewezen aan de afbeelding van de knop.

void SetImageIndex(
    int nIndex,
    BOOL bLargeImage);

Parameterwaarden

nIndex
[in] Hiermee geeft u de afbeeldingsindex.

bLargeImage
[in] Als WAAR is, verwijst de opgegeven index naar de lijst met grote afbeeldingen. Anders verwijst de index naar de lijst met kleine afbeeldingen.

CMFCRibbonButton::SetMenu

Hiermee wordt een snelmenu toegewezen aan de lintknop.

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

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

Parameterwaarden

hMenu
Een ingang naar een Windows-menu.

bIsDefaultCommand
Als WAAR is, kan de knop de standaardopdracht uitvoeren; anders wordt op de knop een snelmenu weergegeven.

bRightAlign
Als WAAR is, wordt het menu rechts uitgelijnd. Anders wordt het menu links uitgelijnd.

uiMenuResID
Een menuresource-id.

Opmerkingen

Wanneer de toepassing het menu aan de knop toewijst, wordt op de knop een pijl aan de rechterkant weergegeven. Als bIsDefaultCommand TRUE is, wordt het menu alleen weergegeven wanneer de gebruiker op de pijl klikt. Als de gebruiker op de knop klikt, wordt de standaardopdracht uitgevoerd. Als bIsDefaultCommand ONWAAR is, wordt het menu weergegeven door ergens op de knop te klikken.

CMFCRibbonButton::SetParentCategory

virtual void SetParentCategory(CMFCRibbonCategory* pParent);

Parameterwaarden

[in] pParent

Opmerkingen

CMFCRibbonButton::SetRightAlignMenu

Hiermee wordt het snelmenu uitgelijnd op de rand van de knop.

void SetRightAlignMenu(BOOL bSet=TRUE);

Parameterwaarden

bSet
[in] Als WAAR is, wordt het menu rechts uitgelijnd. Anders wordt het menu links uitgelijnd

CMFCRibbonButton::SetText

virtual void SetText(LPCTSTR lpszText);

Parameterwaarden

[in] lpszText

Opmerkingen

Zie ook

Hiƫrarchiegrafiek
Klassen