Partager via

CMFCRibbonComboBox, classe

  • Article

La CMFCRibbonComboBox classe implémente un contrôle de zone de liste modifiable que vous pouvez ajouter à une barre de ruban, un panneau de ruban ou un menu contextuel du ruban.

Syntaxe

class CMFCRibbonComboBox : public CMFCRibbonEdit

Membres

Constructeurs

Nom Description
CMFCRibbonComboBox ::CMFCRibbonComboBox Construit un objet CMFCRibbonComboBox.

Méthodes publiques

Nom Description
CMFCRibbonComboBox ::AddItem Ajoute un élément unique à la zone de liste.
CMFCRibbonComboBox ::D eleteItem Supprime un élément spécifié de la zone de liste.
CMFCRibbonComboBox ::EnableDropDownListResize Spécifie si la zone de liste peut modifier la taille lorsqu’elle est déroulante.
CMFCRibbonComboBox ::FindItem Retourne l’index du premier élément dans la zone de liste qui correspond à une chaîne spécifiée.
CMFCRibbonComboBox ::GetCount Retourne le nombre d’éléments dans la zone de liste.
CMFCRibbonComboBox ::GetCurSel Obtient l’index de l’élément actuellement sélectionné dans la zone de liste.
CMFCRibbonComboBox ::GetDropDownHeight Obtient la hauteur de la zone de liste lorsque la zone de liste est supprimée.
CMFCRibbonComboBox ::GetIntermediateSize Retourne la taille de la zone de liste modifiable comme indiqué en mode intermédiaire.
CMFCRibbonComboBox ::GetItem Retourne la chaîne associée à un élément à un index spécifié dans la zone de liste.
CMFCRibbonComboBox ::GetItemData Retourne les données associées à un élément à un index spécifié dans la zone de liste.
CMFCRibbonComboBox ::HasEditBox Indique si le contrôle contient une zone d’édition.
CMFCRibbonComboBox ::IsResizeDropDownList Indique si la zone de liste peut être redimensionnée ou non.
CMFCRibbonComboBox ::OnSelectItem Appelé par l’infrastructure lorsque l’utilisateur sélectionne un élément dans la zone de liste.
CMFCRibbonComboBox ::RemoveAllItems Supprime tous les éléments de la zone de liste et efface la zone d’édition.
CMFCRibbonComboBox ::SelectItem Sélectionne un élément dans la zone de liste.
CMFCRibbonComboBox ::SetDropDownHeight Définit la hauteur de la zone de liste lorsqu’elle est supprimée.

Notes

La zone de liste modifiable du ruban se compose d’une zone de liste combinée à une étiquette statique ou à une étiquette qui peut être modifiée par l’utilisateur. Vous devez spécifier le type souhaité lorsque vous créez votre zone de liste déroulante du ruban.

Exemple

L’exemple suivant montre comment construire un objet de la CMFCRibbonComboBox classe, ajouter un élément à la zone de liste modifiable, sélectionner un élément dans la zone de liste modifiable et ajouter une zone de liste modifiable à un panneau.

// Create a simple combo box with two entries:
// The first parameter is the id of the combo box.
// The third parameter is the width of the combo box in pixels.
// The fourth parameter is the display label of the combo box.
// The fifth parameter is the index of the small image of the combo box.
CMFCRibbonComboBox *pComboSimple = new CMFCRibbonComboBox(-1, FALSE, -1, 0, -1);

// Add two items to the combo box and select the first item in the list:
pComboSimple->AddItem(_T("Hi!"));
pComboSimple->AddItem(_T("Hello!"));
pComboSimple->SelectItem(0);

// Add combo button to "Favorites" panel:
// CMFCRibbonPanel* pPanelFavorites
pPanelFavorites->Add(pComboSimple);

Hiérarchie d'héritage

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

CMFCRibbonEdit

CMFCRibbonComboBox

Spécifications

En-tête : afxribboncombobox.h

CMFCRibbonComboBox ::AddItem

Ajoute un élément unique à la zone de liste.

virtual INT_PTR AddItem(
    LPCTSTR lpszItem,
    DWORD_PTR dwData=0);

Paramètres

lpszItem
[in] Chaîne de l’élément à ajouter.

dwData
[in] Données associées à l’élément à ajouter.

Valeur de retour

Index de base zéro de l’élément ajouté.

CMFCRibbonComboBox ::CMFCRibbonComboBox

Construit un objet CMFCRibbonComboBox.

public:
CMFCRibbonComboBox(
    UINT nID,
    BOOL bHasEditBox=TRUE,
    Int nWidth=-1,
    LPCTSTR lpszLabel=NULL,
    Int nImage=-1);

protected:
CMFCRibbonComboBox();

Paramètres

nID
[in] ID de la zone de liste modifiable.

bHasEditBox
[in] TRUE si vous souhaitez une zone d’édition dans le contrôle ; FALSE dans le cas contraire.

nWidth
[in] Largeur de la zone de liste modifiable en pixels ; ou -1 pour la largeur par défaut.

lpszLabel
[in] Étiquette d’affichage de la zone de liste modifiable.

nImage
[in] Index de petite image de la zone de liste déroulante.

Notes

La largeur par défaut est de 108 pixels.

CMFCRibbonComboBox ::D eleteItem

Supprime un élément spécifié de la zone de liste.

BOOL DeleteItem(int iIndex);
BOOL DeleteItem(DWORD_PTR dwData);

BOOL DeleteItem(LPCTSTR lpszText);

Paramètres

iIndex
[in] Index de base zéro de l’élément à supprimer.

dwData
[in] Données associées à l’élément à supprimer.

lpszText
[in] Chaîne de l’élément à supprimer. S’il existe plusieurs éléments avec la même chaîne, le premier élément est supprimé.

Valeur de retour

TRUE si l’élément spécifié a été supprimé ; sinon, FALSE.

Notes

CMFCRibbonComboBox ::EnableDropDownListResize

Spécifie si la zone de liste peut modifier la taille lorsqu’elle est déroulante.

void EnableDropDownListResize(BOOL bEnable=FALSE);

Paramètres

bEnable
[in] TRUE pour activer le redimensionnement ; FALSE pour désactiver le redimensionnement.

Notes

Lorsque le redimensionnement est activé, la zone de liste change la taille pour qu’elle corresponde aux éléments qu’elle affiche.

CMFCRibbonComboBox ::FindItem

Retourne l’index du premier élément dans la zone de liste qui correspond à une chaîne spécifiée.

int FindItem(LPCTSTR lpszText) const;

Paramètres

lpszText
[in] Chaîne d’un élément dans la zone de liste.

Valeur de retour

Index de base zéro de l’élément ; ou -1 si l’élément est introuvable.

Notes

CMFCRibbonComboBox ::GetCount

Retourne le nombre d’éléments dans la zone de liste.

INT_PTR GetCount() const;

Valeur de retour

Nombre d’éléments dans la zone de liste ou 0 si la zone de liste ne contient aucun élément.

Notes

CMFCRibbonComboBox ::GetCurSel

Obtient l’index de l’élément actuellement sélectionné dans la zone de liste.

int GetCurSel() const;

Valeur de retour

Index de base zéro de l’élément actuellement sélectionné dans la zone de liste ; ou -1 si aucun élément n’est sélectionné.

CMFCRibbonComboBox ::GetDropDownHeight

Obtient la hauteur de la zone de liste lorsque la zone de liste est supprimée.

int GetDropDownHeight();

Valeur de retour

Hauteur, en pixels, de la zone de liste.

Notes

CMFCRibbonComboBox ::GetIntermediateSize

Retourne la taille de la zone de liste modifiable comme indiqué en mode intermédiaire.

virtual CSize GetIntermediateSize(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour la zone de liste déroulante.

Valeur de retour

Taille de la zone de liste modifiable.

Notes

La taille retournée est basée sur la taille de la zone de liste déroulante lorsqu’elle affiche de petites images.

CMFCRibbonComboBox ::GetItem

Retourne la chaîne associée à un élément à un index spécifié dans la zone de liste.

LPCTSTR GetItem(int iIndex) const;

Paramètres

iIndex
[in] Index de base zéro d’un élément dans la zone de liste.

Valeur de retour

Pointeur vers la chaîne associée à l’élément ; sinon, NULL si le paramètre d’index n’est pas valide ou si le paramètre d’index est -1 et qu’aucun élément n’est sélectionné dans la zone de liste déroulante.

Notes

CMFCRibbonComboBox ::GetItemData

Retourne les données associées à un élément à un index spécifié dans la zone de liste.

DWORD_PTR GetItemData(int iIndex) const;

Paramètres

iIndex
[in] Index de base zéro d’un élément dans la zone de liste.

Valeur de retour

Données associées à l’élément ; ou 0 si l’élément n’existe pas, ou si le paramètre d’index est -1 et qu’il n’existe aucun élément sélectionné dans la zone de liste.

CMFCRibbonComboBox ::HasEditBox

Indique si le contrôle contient une zone d’édition.

BOOL HasEditBox() const;

Valeur de retour

TRUE si le contrôle contient une zone d’édition ; sinon, FALSE.

Notes

CMFCRibbonComboBox ::IsResizeDropDownList

Indique si la zone de liste peut être redimensionnée ou non.

BOOL IsResizeDropDownList() const;

Valeur de retour

TRUE si la zone de liste peut être redimensionnée ; sinon FALSE. CMFCRibbonComboBox ::EnableDropDownListResize

Notes

Vous pouvez activer le redimensionnement des zones de liste à l’aide de la méthode CMFCRibbonComboBox ::EnableDropDownListResize .

CMFCRibbonComboBox ::OnSelectItem

Appelé par l’infrastructure lorsqu’un utilisateur sélectionne un élément dans la zone de liste.

virtual void OnSelectItem(int nItem);

Paramètres

nItem
[in] Index de l’élément sélectionné.

Notes

Remplacez cette méthode si vous souhaitez traiter une sélection d’entrée utilisateur.

CMFCRibbonComboBox ::RemoveAllItems

Supprime tous les éléments de la zone de liste et efface la zone d’édition.

void RemoveAllItems();

Notes

CMFCRibbonComboBox ::SelectItem

Sélectionne un élément dans la zone de liste.

BOOL SelectItem(int iIndex);
BOOL SelectItem(DWORD_PTR dwData);

BOOL SelectItem(LPCTSTR lpszText);

Paramètres

iIndex
[in] Index de base zéro d’un élément dans la zone de liste.

dwData
[in] Données associées à un élément dans la zone de liste.

lpszText
[in] Chaîne d’un élément dans la zone de liste.

Valeur de retour

TRUE si la méthode a réussi ; sinon FALSE.

Notes

CMFCRibbonComboBox ::SetDropDownHeight

Définit la hauteur de la zone de liste lorsqu’elle est supprimée.

void SetDropDownHeight(int nHeight);

Paramètres

nHeight
[in] Hauteur, en pixels, de la zone de liste.

Notes

La hauteur par défaut est de 150 pixels.

Voir aussi

Graphique hiérarchique
Classes
CMFCRibbonEdit, classe