Partager via

CMFCRibbonEdit, classe

  • Article

Implémente un contrôle d’édition situé sur une barre de ruban.

Syntaxe

class CMFCRibbonEdit : public CMFCRibbonButton

Membres

Constructeurs publics

Nom Description
CMFCRibbonEdit ::CMFCRibbonEdit Construit un objet CMFCRibbonEdit.

Méthodes publiques

Nom Description
CMFCRibbonEdit ::CanBeStretched Indique si la hauteur du CMFCRibbonEdit contrôle peut augmenter verticalement à la hauteur d’une ligne de ruban.
CMFCRibbonEdit ::CMFCRibbonEdit Construit un objet CMFCRibbonEdit.
CMFCRibbonEdit ::CopyFrom Copie l’état de l’objet spécifié CMFCRibbonEdit dans l’objet actif CMFCRibbonEdit .
CMFCRibbonEdit ::CreateEdit Crée une zone de texte pour l’objet CMFCRibbonEdit .
CMFCRibbonEdit ::D estroyCtrl Détruit l’objet CMFCRibbonEdit .
CMFCRibbonEdit ::D ropDownList Supprime une zone de liste.
CMFCRibbonEdit ::EnableSpinButtons Active et définit la plage du bouton de rotation pour la zone de texte.
CMFCRibbonEdit ::GetCompactSize Récupère la taille compacte de l’objet CFMCRibbonEdit .
CMFCRibbonEdit ::GetEditText Récupère le texte dans la zone de texte.
CMFCRibbonEdit ::GetIntermediateSize Récupère la taille intermédiaire de l’objet CMFCRibbonEdit .
CMFCRibbonEdit ::GetTextAlign Récupère l’alignement du texte dans la zone de texte.
CMFCRibbonEdit ::GetWidth Récupère la largeur, en pixels, du CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::HasCompactMode Indique si la taille d’affichage du CMFCRibbonEdit contrôle peut être compacte.
CMFCRibbonEdit ::HasFocus Indique si le CMFCRIbbonEdit contrôle a le focus.
CMFCRibbonEdit ::HasLargeMode Indique si la taille d’affichage du CMFCRibbonEdit contrôle peut être grande.
CMFCRibbonEdit ::HasSpinButtons Indique si la zone de texte a un bouton de rotation.
CMFCRibbonEdit ::IsHighlighted Indique si le CMFCRibbonEdit contrôle est mis en surbrillance.
CMFCRibbonEdit ::OnAfterChangeRect Appelé par l’infrastructure lorsque les dimensions du rectangle d’affichage pour le CMFCRibbonEdit contrôle changent.
CMFCRibbonEdit ::OnDraw Appelé par l’infrastructure pour dessiner le CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::OnDrawLabelAndImage Appelé par l’infrastructure pour dessiner l’étiquette et l’image du CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::OnDrawOnList Appelé par l’infrastructure pour dessiner le CMFCRibbonEdit contrôle dans une zone de liste de commandes.
CMFCRibbonEdit ::OnEnable Appelé par l’infrastructure pour activer ou désactiver le CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::OnHighlight Appelé par l’infrastructure lorsque le pointeur entre ou quitte les limites du CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::OnKey Appelé par l’infrastructure lorsque l’utilisateur appuie sur une info-bulle et que le CMFCRibbonEdit contrôle a le focus.
CMFCRibbonEdit ::OnLButtonDown Appelé par l’infrastructure pour mettre à jour le CMFCRibbonEdit contrôle lorsque l’utilisateur appuie sur le bouton gauche de la souris sur le contrôle.
CMFCRibbonEdit ::OnLButtonUp Appelé par l’infrastructure lorsque l’utilisateur relâche le bouton gauche de la souris.
CMFCRibbonEdit ::OnRTLChanged Appelé par l’infrastructure pour mettre à jour le CMFCRibbonEdit contrôle lorsque la disposition change de direction.
CMFCRibbonEdit ::OnShow Appelé par l’infrastructure pour afficher ou masquer le CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::Redraw Met à jour l’affichage du CMFCRibbonEdit contrôle.
CMFCRibbonEdit ::SetACCData Définit les données d’accessibilité de l’objet CMFCRibbonEdit .
CMFCRibbonEdit ::SetEditText Définit le texte dans la zone de texte.
CMFCRibbonEdit ::SetTextAlign Définit l’alignement du texte de la zone de texte.
CMFCRibbonEdit ::SetWidth Définit la largeur de la zone de texte du CMFCRibbonEdit contrôle.

Notes

Exemple

L’exemple suivant montre comment construire un CMFCRibbonEdit objet, afficher les boutons de rotation en regard du contrôle d’édition et définir le texte du contrôle d’édition. Cet extrait de code fait partie de l’exemple de démonstration MS Office 2007.

CMFCRibbonEdit *pEditIndentLeft = new CMFCRibbonEdit(ID_PAGELAYOUT_INDENT_LEFT, 72, _T("Left:\nil"), 13);
// specify the min and max value of the spin button control
pEditIndentLeft->EnableSpinButtons(0, 1000);
// set the text of the edit control
pEditIndentLeft->SetEditText(_T("0"));

Spécifications

En-tête : afxRibbonEdit.h

CMFCRibbonEdit ::CanBeStretched

Indique si la hauteur du contrôle CMFCRibbonEdit peut augmenter verticalement à la hauteur d’une ligne de ruban.

virtual BOOL CanBeStretched();

Valeur de retour

Retourne toujours FALSE.

Notes

CMFCRibbonEdit ::CMFCRibbonEdit

Construit un objet CMFCRibbonEdit .

CMFCRibbonEdit(
    UINT nID,
    int nWidth,
    LPCTSTR lpszLabel = NULL,
    int nImage = -1);

CMFCRibbonEdit();

Paramètres

nID
[in] ID de commande du CMFCRibbonEdit contrôle.

nWidth
[in] Largeur, en pixels, de la zone de texte du CMFCRibbonEdit contrôle.

lpszLabel
[in] Étiquette du CMFCRibbonEdit contrôle.

nImage
[in] Index de la petite image à utiliser pour le CMFCRibbonEdit contrôle. La collection de petites images est conservée par la catégorie du ruban parent.

Notes

Le CMFCRibbonEdit contrôle n’utilise pas d’image volumineuse.

CMFCRibbonEdit ::CopyFrom

Copie l’état de l’objet CMFCRibbonEdit spécifié dans l’objet CMFCRibbonEdit actuel.

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Paramètres

src
[in] Objet source CMFCRibbonEdit .

Notes

Le paramètre src doit être de type CMFCRibbonEdit.

CMFCRibbonEdit ::CreateEdit

Crée une zone de texte pour l’objet CMFCRibbonEdit .

virtual CMFCRibbonRichEditCtrl* CreateEdit(
    CWnd* pWndParent,
    DWORD dwEditStyle);

Paramètres

pWndParent
[in] Pointeur vers la fenêtre parente de l’objet CMFCRibbonEdit .

dwEditStyle
[in] Spécifie le style de la zone de texte. Vous pouvez combiner les styles de fenêtre répertoriés dans la section Remarques avec les styles de contrôle d’édition décrits dans le Kit de développement logiciel (SDK) Windows.

Valeur de retour

Pointeur vers la nouvelle zone de texte si la méthode a réussi ; sinon, NULL.

Notes

Remplacez cette méthode dans une classe dérivée pour créer une zone de texte personnalisée.

Vous pouvez appliquer les styles de fenêtre suivants à une zone de texte :

  • WS_CHILD

  • WS_VISIBLE

  • WS_DISABLED

  • WS_GROUP

  • WS_TABSTOP

CMFCRibbonEdit ::D estroyCtrl

Détruit l’objet CMFCRibbonEdit .

virtual void DestroyCtrl();

Notes

Supprime une zone de liste.

virtual void DropDownList();

Notes

Par défaut, cette méthode ne fait rien. Remplacez cette méthode pour supprimer une zone de liste.

CMFCRibbonEdit ::EnableSpinButtons

Active et définit la plage du bouton de rotation pour la zone de texte.

void EnableSpinButtons(
    int nMin,
    int nMax);

Paramètres

nMin
[in] Valeur minimale du bouton spin.

nMax
[in] Valeur maximale du bouton de rotation.

Notes

Les boutons spin affichent une flèche vers le haut et le bas et permettent aux utilisateurs de parcourir un ensemble fixe de valeurs.

CMFCRibbonEdit ::GetCompactSize

Récupère la taille compacte de l’objet CMFCRibbonEdit .

virtual CSize GetCompactSize(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour l’objet CMFCRibbonEdit .

Valeur de retour

Taille compacte de l’objet CMFCRibbonEdit .

Notes

CMFCRibbonEdit ::GetEditText

Récupère le texte dans la zone de texte.

CString GetEditText() const;

Valeur de retour

Texte de la zone de texte.

Notes

CMFCRibbonEdit ::GetIntermediateSize

Récupère la taille intermédiaire de l’objet CMFCRibbonEdit .

virtual CSize GetIntermediateSize(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour l’objet CMFCRibbonEdit .

Valeur de retour

Taille intermédiaire de l’objet CMFCRibbonEdit .

Notes

CMFCRibbonEdit ::GetTextAlign

Récupère l’alignement du texte dans la zone de texte.

int GetTextAlign() const;

Valeur de retour

Valeur énumérée de l’alignement du texte. Consultez la section Remarques pour connaître les valeurs possibles.

Notes

La valeur retournée est l’un des styles de contrôle d’édition suivants :

  • ES_LEFT pour l’alignement gauche

  • ES_CENTER pour l’alignement central

  • ES_RIGHT pour l’alignement droit

Pour plus d’informations sur ces styles, consultez Modifier les styles de contrôle.

CMFCRibbonEdit ::GetWidth

Récupère la largeur, en pixels, du contrôle CMFCRibbonEdit .

int GetWidth(BOOL bInFloatyMode = FALSE) const;

Paramètres

bInFloatyMode
[in] TRUE si le CMFCRibbonEdit contrôle est en mode flottant ; sinon, FALSE.

Valeur de retour

Largeur, en pixels, du CMFCRibbonEdit contrôle.

Notes

CMFCRibbonEdit ::HasCompactMode

Indique si la taille d’affichage du contrôle CMFCRibbonEdit peut être compacte.

virtual BOOL HasCompactMode() const;

Valeur de retour

Retourne toujours TRUE.

Notes

Par défaut, cette méthode retourne toujours TRUE. Remplacez cette méthode pour indiquer si la taille d’affichage peut être compacte.

CMFCRibbonEdit ::HasFocus

Indique si le contrôle CMFCRibbonEdit a le focus.

virtual BOOL HasFocus() const;

Valeur de retour

TRUE si le CMFCRibbonEdit contrôle a le focus ; sinon FALSE.

Notes

CMFCRibbonEdit ::HasLargeMode

Indique si la taille d’affichage du contrôle CMFCRibbonEdit peut être volumineuse.

virtual BOOL HasLargeMode() const;

Valeur de retour

Retourne toujours FALSE.

Notes

Par défaut, cette méthode retourne toujours FALSE. Remplacez cette méthode pour indiquer si la taille d’affichage peut être grande.

CMFCRibbonEdit ::HasSpinButtons

Indique si la zone de texte a un bouton de rotation.

virtual BOOL HasSpinButtons() const;

Valeur de retour

TRUE si la zone de texte a un bouton de rotation ; sinon FALSE.

Notes

CMFCRibbonEdit ::IsHighlighted

Indique si le contrôle CMFCRibbonEdit est mis en surbrillance.

virtual BOOL IsHighlighted() const;

Valeur de retour

TRUE si le CMFCRibbonEdit contrôle est mis en surbrillance ; sinon FALSE.

Notes

CMFCRibbonEdit ::OnAfterChangeRect

Appelé par l’infrastructure lorsque les dimensions du rectangle d’affichage pour le contrôle CMFCRibbonEdit changent.

virtual void OnAfterChangeRect(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le CMFCRibbonEdit contrôle.

Notes

CMFCRibbonEdit ::OnDraw

Appelé par l’infrastructure pour dessiner le contrôle CMFCRibbonEdit .

virtual void OnDraw(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le CMFCRibbonEdit contrôle.

Notes

CMFCRibbonEdit ::OnDrawLabelAndImage

Appelé par l’infrastructure pour dessiner l’étiquette et l’image du contrôle CMFCRibbonEdit .

virtual void OnDrawLabelAndImage(CDC* pDC);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le CMFCRibbonEdit contrôle.

Notes

CMFCRibbonEdit ::OnDrawOnList

Appelé par l’infrastructure pour dessiner le contrôle CMFCRibbonEdit dans une zone de liste de commandes.

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le CMFCRibbonEdit contrôle.

strText
[in] Texte d’affichage.

nTextOffset
[in] Distance, en pixels, du côté gauche de la zone de liste au texte d’affichage.

rect
[in] Rectangle d’affichage du CMFCRibbonEdit contrôle.

bIsSelected
[in] Ce paramètre n’est pas utilisé.

bHighlighted
[in] Ce paramètre n’est pas utilisé.

Notes

La zone de liste des commandes affiche les contrôles du ruban pour permettre aux utilisateurs de personnaliser la barre d’outils accès rapide.

CMFCRibbonEdit ::OnEnable

Appelé par l’infrastructure pour activer ou désactiver le contrôle CMFCRibbonEdit .

virtual void OnEnable(BOOL bEnable);

Paramètres

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

Notes

CMFCRibbonEdit ::OnHighlight

Appelé par l’infrastructure lorsque le pointeur entre ou quitte les limites du contrôle CMFCRibbonEdit .

virtual void OnHighlight(BOOL bHighlight);

Paramètres

bHighlight
[in] TRUE si le pointeur se trouve dans les limites du CMFCRibbonEdit contrôle ; sinon, FALSE.

Notes

CMFCRibbonEdit ::OnKey

Appelé par l’infrastructure lorsque l’utilisateur appuie sur une touche d’info-bulle et que le contrôle CMFCRibbonEdit a le focus.

virtual BOOL OnKey(BOOL bIsMenuKey);

Paramètres

bIsMenuKey
[in] TRUE si l’info-bulle affiche un menu contextuel ; sinon, FALSE.

Valeur de retour

TRUE si l’événement a été géré ; sinon, FALSE.

Notes

CMFCRibbonEdit ::OnLButtonDown

Appelé par l’infrastructure pour mettre à jour le contrôle CMFCRibbonEdit lorsque l’utilisateur appuie sur le bouton gauche de la souris sur le contrôle.

virtual void OnLButtonDown(CPoint point);

Paramètres

point
[in] Ce paramètre n’est pas utilisé.

Notes

CMFCRibbonEdit ::OnLButtonUp

Appelé par l’infrastructure lorsque l’utilisateur relâche le bouton gauche de la souris.

virtual void OnLButtonUp(CPoint point);

Paramètres

point
[in] Ce paramètre n’est pas utilisé.

Notes

CMFCRibbonEdit ::OnRTLChanged

Appelé par l’infrastructure pour mettre à jour le contrôle CMFCRibbonEdit lorsque la disposition change de direction.

virtual void OnRTLChanged(BOOL bIsRTL);

Paramètres

bIsRTL
[in] TRUE si la disposition est de droite à gauche ; FALSE si la disposition est de gauche à droite.

Notes

CMFCRibbonEdit ::OnShow

Appelé par l’infrastructure pour afficher ou masquer le contrôle CMFCRibbonEdit .

virtual void OnShow(BOOL bShow);

Paramètres

bShow
[in] TRUE pour afficher le contrôle ; FALSE pour masquer le contrôle.

Notes

CMFCRibbonEdit ::Redraw

Met à jour l’affichage du contrôle CMFCRibbonEdit .

virtual void Redraw();

Notes

Cette méthode redessine le rectangle d’affichage de l’objet CMFCRibbonEdit en appelant indirectement CWnd ::RedrawWindow avec les indicateurs RDW_INVALIDATE, RDW_ERASE et RDW_UPDATENOW définis.

CMFCRibbonEdit ::SetACCData

Définit les données d’accessibilité de l’objet CMFCRibbonEdit .

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

Paramètres

pParent
Pointeur vers la fenêtre parente de l’objet CMFCRibbonEdit .

data
Données d’accessibilité de l’objet CMFCRibbonEdit .

Valeur de retour

Retourne toujours TRUE.

Notes

CMFCRibbonEdit ::SetEditText

Définit le texte dans la zone de texte.

void SetEditText(CString strText);

Paramètres

strText
[in] Texte de la zone de texte.

CMFCRibbonEdit ::SetTextAlign

Définit l’alignement du texte de la zone de texte.

void SetTextAlign(int nAlign);

Paramètres

nAlign
[in] Valeur énumérée de l’alignement du texte. Consultez la section Remarques pour connaître les valeurs possibles.

Notes

Le paramètre nAlign est l’un des styles de contrôle d’édition suivants :

  • ES_LEFT pour l’alignement gauche

  • ES_CENTER pour l’alignement central

  • ES_RIGHT pour l’alignement droit

Pour plus d’informations sur ces styles, consultez Modifier les styles de contrôle.

CMFCRibbonEdit ::SetWidth

Définit la largeur de la zone de texte du contrôle CMFCRibbonEdit .

void SetWidth(
    int nWidth,
    BOOL bInFloatyMode = FALSE);

Paramètres

nWidth
[in] Largeur, en pixels, de la zone de texte.

bInFloatyMode
TRUE pour définir la largeur du mode flottant ; FALSE pour définir la largeur du mode normal.

Notes

Le CMFCRibbonEdit contrôle a deux largeurs en fonction de son mode d’affichage : le mode flottant et le mode normal.

Voir aussi

Graphique hiérarchique
Classes
CMFCRibbonButton, classe
CMFCRibbonBar, classe