Estructura CHARFORMATA (richedit.h)

  • Artículo

Contiene información sobre el formato de caracteres en un control de edición enriquecido.

Rich Edit 2.0: La estructura CHARFORMAT2 es una extensión de Microsoft Rich Edit 2.0 de la estructura CHARFORMAT . Microsoft Rich Edit 2.0 y versiones posteriores le permiten usar cualquiera de las estructuras con los mensajes EM_GETCHARFORMAT y EM_SETCHARFORMAT .

Sintaxis

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

Miembros

cbSize

Tipo: UINT

Tamaño en bytes de la estructura especificada. Este miembro debe establecerse antes de pasar la estructura al control de edición enriquecido.

dwMask

Tipo: DWORD

Miembros que contienen información o atributos válidos que se van a establecer. Este miembro puede ser cero, uno o más de uno de los valores siguientes.

Valor Significado
CFM_ALL
 Windows 8: combinación de los siguientes valores: CFM_EFFECTS | CFM_SIZE | CFM_FACE | CFM_OFFSET | CFM_CHARSET
CFM_BOLD
 El valor CFE_BOLD del miembro dwEffects es válido.
CFM_CHARSET
 El miembro bCharSet es válido.
CFM_COLOR
 El miembro crTextColor y el valor CFE_AUTOCOLOR del miembro dwEffects son válidos .
CFM_EFFECTS
 Windows 8: combinación de los siguientes valores: CFM_BOLD | CFM_ITALIC | CFM_UNDERLINE | CFM_COLOR | CFM_STRIKEOUT | CFE_PROTECTED | CFM_LINK
CFM_FACE
 El miembro szFaceName es válido.
CFM_ITALIC
 El valor CFE_ITALIC del miembro dwEffects es válido.
CFM_OFFSET
 El miembro yOffset es válido.
CFM_PROTECTED
 El valor CFE_PROTECTED del miembro dwEffects es válido.
CFM_SIZE
 El miembro yHeight es válido.
CFM_STRIKEOUT
 El valor CFE_STRIKEOUT del miembro dwEffects es válido.
CFM_UNDERLINE.
 El valor CFE_UNDERLINE del miembro dwEffects es válido.

dwEffects

Tipo: DWORD

Efectos de caracteres. Este miembro puede ser una combinación de los valores siguientes.

Valor Significado
CFE_AUTOCOLOR
 El color del texto es el valor devuelto de GetSysColor(COLOR_WINDOWTEXT).
CFE_BOLD
 Los caracteres son negrita.
CFE_DISABLED
 RichEdit 2.0 y versiones posteriores: Los caracteres se muestran con una sombra que se desplaza por 3/4 puntos o un píxel, lo que sea mayor.
CFE_ITALIC
 Los caracteres son cursiva.
CFE_STRIKEOUT
 Se golpean los caracteres.
CFE_UNDERLINE
 Los caracteres están subrayados.
CFE_PROTECTED
 Los caracteres están protegidos; Un intento de modificarlos provocará un código de notificación EN_PROTECTED .

yHeight

Tipo: LONG

Alto de caracteres, en twips (1/1440 de una pulgada o 1/20 del punto de una impresora).

yOffset

Tipo: LONG

Desplazamiento de caracteres, en twips, desde la línea base. Si el valor de este miembro es positivo, el carácter es un superíndice; si es negativo, el carácter es un subíndice.

crTextColor

Tipo: COLORREF

Color del texto. Este miembro se omite si se especifica el efecto de carácter CFE_AUTOCOLOR. Para generar un COLORREF, use la macro RGB .

bCharSet

Tipo: BYTE

Valor del juego de caracteres. El miembro bCharSet puede ser uno de los valores especificados para el miembro lfCharSet de la estructura LOGFONT . Microsoft Rich Edit 3.0 puede invalidar este valor si no es válido para los caracteres de destino.

bPitchAndFamily

Tipo: BYTE

Familia de fuentes y tono. Este miembro es el mismo que el miembro lfPitchAndFamily de la estructura LOGFONT .

szFaceName[LF_FACESIZE]

Tipo: TCHAR[LF_FACESIZE]

Matriz de caracteres terminada en NULL que especifica el nombre de fuente.

Comentarios

Para desactivar un atributo de formato, establezca el valor adecuado en dwMask , pero no establezca el valor correspondiente en dwEffects. Por ejemplo, para desactivar cursiva, establezca CFM_ITALIC pero no establezca CFE_ITALIC.

Nota

El encabezado richedit.h define CHARFORMAT como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado richedit.h

Consulte también

CHARFORMAT2

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

Referencia