structure CHARFORMAT2A (richedit.h)

Article
08/15/2024

Contient des informations sur la mise en forme de caractères dans un contrôle d’édition enrichi. CHARFORMAT2 est une extension Microsoft Rich Edit 2.0 de la structure CHARFORMAT. Microsoft Rich Edit 2.0 vous permet d’utiliser l’une ou l’autre structure avec les messages EM_GETCHARFORMAT et EM_SETCHARFORMAT.

Syntaxe

struct CHARFORMAT2A : _charformat {
  WORD     wWeight;
  SHORT    sSpacing;
  COLORREF crBackColor;
  LCID     lcid;
  union {
    DWORD dwReserved;
    DWORD dwCookie;
  };
  DWORD    dwReserved;
  SHORT    sStyle;
  WORD     wKerning;
  BYTE     bUnderlineType;
  BYTE     bAnimation;
  BYTE     bRevAuthor;
  BYTE     bUnderlineColor;
};

Héritage

La structure CHARFORMAT2A implémente _charformat.

Membres

wWeight

Type : WORD

Poids de police. Ce membre est identique au membre lfWeight de la structure LOGFONT. Pour utiliser ce membre, définissez l’indicateur CFM_WEIGHT dans le membre dwMask.

sSpacing

Type : SHORT

Espace horizontal entre les lettres, en twips. Cette valeur n’a aucun effet sur le texte affiché par un contrôle d’édition enrichi ; il est inclus pour la compatibilité avec les interfaces Windows TOM. Pour utiliser ce membre, définissez l’indicateur CFM_SPACING dans le membre dwMask .

crBackColor

Type : COLORREF

Couleur d’arrière-plan. Pour utiliser ce membre, définissez l’indicateur CFM_BACKCOLOR dans le membre dwMask. Ce membre est ignoré si l’effet de caractère CFE_AUTOBACKCOLOR est spécifié. Pour générer un , utilisez la macro.

lcid

Type : LCID

Identificateur de paramètres régionaux 32 bits qui contient un identificateur de langue dans le mot inférieur et un identificateur de tri et une valeur réservée dans le mot supérieur. Ce membre n’a aucun effet sur le texte affiché par un contrôle d’édition enrichi, mais les vérificateurs d’orthographe et de grammaire peuvent l’utiliser pour résoudre les problèmes liés à la langue. Vous pouvez utiliser la macro pour créer une valeur LCID. Pour utiliser ce membre, définissez l’indicateur CFM_LCID dans le membre dwMask .

dwReserved

Type : DWORD

Réservé; la valeur doit être égale à zéro.

dwCookie

Type : DWORD

Cookie client. Ce membre est opaque pour un contrôle d’édition enrichi.

sStyle

Type : SHORT

Poignée de style caractère. Cette valeur n’a aucun effet sur le texte affiché par un contrôle d’édition enrichi ; il est inclus pour la compatibilité avec les interfaces WindowsTOM. Pour utiliser ce membre, définissez l’indicateur de CFM_STYLE dans le membre dwMask . Pour plus d’informations, consultez la documentation TOM.

wKerning

Type : WORD

Valeur de la taille de police, au-dessus de laquelle kernner le caractère (yHeight). Cette valeur n’a aucun effet sur le texte affiché par un contrôle d’édition enrichi ; il est inclus pour la compatibilité avec les interfaces TOM. Pour utiliser ce membre, définissez l’indicateur CFM_KERNING dans le membre dwMask.

bUnderlineType

Type : BYTE

Spécifie le type de soulignement. Pour utiliser ce membre, définissez l’indicateur CFM_UNDERLINETYPE dans le membre dwMask. Ce membre peut être l’une des valeurs suivantes.

Valeur	Signification
CFU_CF1UNDERLINE	La structure mappe CHARFORMAT's bit souligne à CHARFORMAT2, (autrement dit, il effectue un CHARFORMAT type de soulignement sur ce texte).
CFU_INVERT	Pour la composition de l’IME, faux une sélection.
CFU_UNDERLINE	Texte souligné avec une seule ligne unie.
CFU_UNDERLINEDASH	Texte souligné avec tirets.
CFU_UNDERLINEDASHDOT	Texte souligné avec une ligne pointillée et pointillée.
CFU_UNDERLINEDASHDOTDOT	Texte souligné avec un pointillé et doublé d’une ligne en pointillés.
CFU_UNDERLINEDOTTED	Texte souligné avec une ligne en pointillés. Pour les versions antérieures à Microsoft Rich Edit 3.0, le texte s’affiche avec un trait de soulignement solide.
CFU_UNDERLINEDOUBLE	Texte souligné avec une double ligne. Le contrôle d’édition enrichi affiche le texte avec un trait de soulignement solide.
CFU_UNDERLINEDOUBLEWAVE	Afficher en tant que CFU_UNDERLINEWAVE.
CFU_UNDERLINEHAIRLINE	Afficher en tant que CFU_UNDERLINE.
CFU_UNDERLINEHEAVYWAVE	Afficher en tant que CFU_UNDERLINEWAVE.
CFU_UNDERLINELONGDASH	Afficher en tant que CFU_UNDERLINEDASH.
CFU_UNDERLINENONE	Pas de soulignement. Il s’agit de la valeur par défaut.
CFU_UNDERLINETHICK	Afficher en tant que CFU_UNDERLINE.
CFU_UNDERLINETHICKDASH	Afficher en tant que CFU_UNDERLINEDASH.
CFU_UNDERLINETHICKDASHDOT	Afficher en tant que CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDASHDOTDOT	Afficher en tant que CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDOTTED	Afficher en tant que CFU_UNDERLINEDOT.
CFU_UNDERLINETHICKLONGDASH	Afficher en tant que CFU_UNDERLINEDASH.
CFU_UNDERLINEWAVE	RichEdit 4.1 et versions ultérieures: texte souligné avec une ligne ondulée.
CFU_UNDERLINEWORD	RichEdit 4.1 et versions ultérieures: mots soulignés uniquement. Le contrôle d’édition enrichi affiche le texte avec un trait de soulignement solide.

bAnimation

Type : BYTE

Type d’animation de texte. Cette valeur n’a aucun effet sur le texte affiché par un contrôle d’édition enrichi ; il est inclus pour la compatibilité avec les interfaces TOM. Pour utiliser ce membre, définissez l’indicateur CFM_ANIMATION dans le membre dwMask.

bRevAuthor

Type : BYTE

Index qui identifie l’auteur effectuant une révision. Le contrôle d’édition enrichi utilise des couleurs de texte différentes pour chaque index d’auteur différent. Pour utiliser ce membre, définissez l’indicateur CFM_REVAUTHOR dans le membre dwMask .

bUnderlineColor

Type : BYTE

Couleur de soulignement :

UnderlineColor_Black = 0x00 ;
UnderlineColor_Blue = 0x01 ;
UnderlineColor_Aqua = 0x02 ;
UnderlineColor_Lime = 0x03 ;
UnderlineColor_Fuchsia = 0x04 ;
UnderlineColor_Red = 0x05 ;
UnderlineColor_Yellow = 0x06 ;
UnderlineColor_White = 0x07 ;
UnderlineColor_Navy = 0x08 ;
UnderlineColor_Teal = 0x09 ;
UnderlineColor_Green = 0x0A ;
UnderlineColor_Purple = 0x0B ;
UnderlineColor_Maroon = 0x0C ;
UnderlineColor_Olive = 0x0D ;
UnderlineColor_DkGray = 0x0E ;
UnderlineColor_LtGray = 0x0F ;

Remarques

Pour désactiver un attribut de mise en forme, définissez la valeur appropriée dans dwMask, mais ne définissez pas la valeur correspondante dans dwEffects. Par exemple, pour désactiver les italiques, définissez CFM_ITALIC, mais ne définissez pas CFE_ITALIC.

Note

L’en-tête richedit.h définit CHARFORMAT2 en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
d’en-tête	richedit.h