Structure CHARFORMATA (richedit.h)

Article
08/25/2023

Contient des informations sur la mise en forme des caractères dans un contrôle d’édition enrichi.

Rich Edit 2.0 : La structure CHARFORMAT2 est une extension Microsoft Rich Edit 2.0 de la structure CHARFORMAT . Microsoft Rich Edit 2.0 et versions ultérieures vous permet d’utiliser l’une ou l’autre structure avec les messages EM_GETCHARFORMAT et EM_SETCHARFORMAT .

Syntaxe

typedef struct _charformat {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  char     szFaceName[LF_FACESIZE];
} CHARFORMATA;

Membres

cbSize

Type : UINT

Taille en octets de la structure spécifiée. Ce membre doit être défini avant de passer la structure au contrôle d’édition enrichi.

dwMask

Type : DWORD

Membres contenant des informations ou des attributs valides à définir. Ce membre peut être zéro, une ou plusieurs des valeurs suivantes.

Valeur	Signification
CFM_ALL	Windows 8 : combinaison des valeurs suivantes : CFM_EFFECTS \| CFM_SIZE \| CFM_FACE \| CFM_OFFSET \| CFM_CHARSET
CFM_BOLD	La valeur CFE_BOLD du membre dwEffects est valide.
CFM_CHARSET	Le membre bCharSet est valide.
CFM_COLOR	Le membre crTextColor et la valeur CFE_AUTOCOLOR du membre dwEffects sont valides .
CFM_EFFECTS	Windows 8 : combinaison des valeurs suivantes : CFM_BOLD \| CFM_ITALIC \| CFM_UNDERLINE \| CFM_COLOR \| CFM_STRIKEOUT \| CFE_PROTECTED \| CFM_LINK
CFM_FACE	Le membre szFaceName est valide.
CFM_ITALIC	La valeur CFE_ITALIC du membre dwEffects est valide.
CFM_OFFSET	Le membre yOffset est valide.
CFM_PROTECTED	La valeur CFE_PROTECTED du membre dwEffects est valide.
CFM_SIZE	Le membre yHeight est valide.
CFM_STRIKEOUT	La valeur CFE_STRIKEOUT du membre dwEffects est valide.
CFM_UNDERLINE.	La valeur CFE_UNDERLINE du membre dwEffects est valide.

dwEffects

Type : DWORD

Effets de caractère. Ce membre peut être une combinaison des valeurs suivantes.

Valeur	Signification
CFE_AUTOCOLOR	La couleur de texte est la valeur de retour de GetSysColor(COLOR_WINDOWTEXT).
CFE_BOLD	Les caractères sont en gras.
CFE_DISABLED	RichEdit 2.0 et versions ultérieures : Les caractères sont affichés avec une ombre décalée de 3/4 points ou d’un pixel, selon la valeur la plus grande.
CFE_ITALIC	Les caractères sont italiques.
CFE_STRIKEOUT	Les caractères sont frappés.
CFE_UNDERLINE	Les caractères sont soulignés.
CFE_PROTECTED	Les caractères sont protégés ; une tentative de modification entraîne une EN_PROTECTED code de notification.

yHeight

Type : LONG

Hauteur des caractères, en twips (1/1440 de pouce ou 1/20 du point d’une imprimante).

yOffset

Type : LONG

Décalage de caractères, en twips, par rapport à la ligne de base. Si la valeur de ce membre est positive, le caractère est un exposant ; s’il est négatif, le caractère est un indice.

crTextColor

Type : COLORREF

Couleur du texte. Ce membre est ignoré si l’effet de caractère CFE_AUTOCOLOR est spécifié. Pour générer un COLORREF, utilisez la macro RVB .

bCharSet

Type : BYTE

Valeur du jeu de caractères. Le membre bCharSet peut être l’une des valeurs spécifiées pour le membre lfCharSet de la structure LOGFONT . Microsoft Rich Edit 3.0 peut remplacer cette valeur si elle n’est pas valide pour les caractères cibles.

bPitchAndFamily

Type : BYTE

Famille de polices et pitch. Ce membre est identique au membre lfPitchAndFamily de la structure LOGFONT .

szFaceName[LF_FACESIZE]

Type : TCHAR[LF_FACESIZE]

Tableau de caractères terminé par null spécifiant le nom de police.

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 l’italique, définissez CFM_ITALIC mais ne définissez pas CFE_ITALIC.

Notes

L’en-tête richedit.h définit CHARFORMAT comme un 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
En-tête	richedit.h

Voir aussi

Référence

Share via