estructura CHARFORMAT2A (richedit.h)

Artículo
08/15/2024

Contiene información sobre el formato de caracteres en un control de edición enriquecido. CHARFORMAT2 es una extensión de Microsoft Rich Edit 2.0 de la estructura CHARFORMAT. Microsoft Rich Edit 2.0 permite usar cualquier estructura con los mensajes EM_GETCHARFORMAT y EM_SETCHARFORMAT.

Sintaxis

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;
};

Herencia

La estructura CHARFORMAT2A implementa _charformat.

Miembros

wWeight

Tipo: word

Peso de fuente. Este miembro es el mismo que el miembro lfWeight de la estructura LOGFONT de . Para usar este miembro, establezca la marca CFM_WEIGHT en el miembro dwMask.

sSpacing

Tipo: SHORT

Espacio horizontal entre letras, en twips. Este valor no tiene ningún efecto en el texto mostrado por un control de edición enriquecido; se incluye para la compatibilidad con las interfaces TOM de Windows. Para usar este miembro, establezca la marca de CFM_SPACING en el miembro dwMask de .

crBackColor

Tipo: COLORREF

Color de fondo. Para usar este miembro, establezca la marca CFM_BACKCOLOR en el miembro dwMask. Este miembro se omite si se especifica el efecto de caracteres CFE_AUTOBACKCOLOR. Para generar un , use la macro .

lcid

Tipo: LCID

Identificador de configuración regional de 32 bits que contiene un identificador de idioma en la palabra inferior y un identificador de ordenación y un valor reservado en la palabra superior. Este miembro no tiene ningún efecto en el texto mostrado por un control de edición enriquecido, pero los correctores ortográficos y gramaticales pueden usarlo para tratar problemas dependientes del idioma. Puede usar la macro para crear un LCID valor. Para usar este miembro, establezca la marca CFM_LCID en el miembro dwMask de .

dwReserved

Tipo: DWORD de

Reservado; el valor debe ser cero.

dwCookie

Tipo: DWORD de

Cookie de cliente. Este miembro es opaco para un control de edición enriquecido.

sStyle

Tipo: SHORT

Identificador de estilo de caracteres. Este valor no tiene ningún efecto en el texto mostrado por un control de edición enriquecido; se incluye para la compatibilidad con interfaces WindowsTOM. Para usar este miembro, establezca la marca CFM_STYLE en el miembro dwMask . Para obtener más información, consulte la documentación de TOM.

wKerning

Tipo: word

Valor del tamaño de fuente, por encima del cual se va a en kern el carácter (yHeight). Este valor no tiene ningún efecto en el texto mostrado por un control de edición enriquecido; se incluye para la compatibilidad con interfaces TOM. Para usar este miembro, establezca la marca CFM_KERNING en el miembro dwMask.

bUnderlineType

Tipo: byte de

Especifica el tipo de subrayado. Para usar este miembro, establezca la marca de CFM_UNDERLINETYPE en el miembro dwMask. Este miembro puede ser uno de los siguientes valores.

Valor	Significado
CFU_CF1UNDERLINE	La estructura asigna CHARFORMATsubrayado de bits a CHARFORMAT2, (es decir, realiza un CHARFORMAT tipo de subrayado en este texto).
CFU_INVERT	Para la composición IME, finga una selección.
CFU_UNDERLINE	Texto subrayado con una sola línea sólida.
CFU_UNDERLINEDASH	Texto subrayado con guiones.
CFU_UNDERLINEDASHDOT	Texto subrayado con una línea discontinua y punteada.
CFU_UNDERLINEDASHDOTDOT	Texto subrayado con una línea de puntos discontinua y duplicada.
CFU_UNDERLINEDOTTED	Texto subrayado con una línea de puntos. Para las versiones anteriores a Microsoft Rich Edit 3.0, el texto se muestra con un subrayado sólido.
CFU_UNDERLINEDOUBLE	Texto subrayado con una línea doble. El control de edición enriquecido muestra el texto con un subrayado sólido.
CFU_UNDERLINEDOUBLEWAVE	Mostrar como CFU_UNDERLINEWAVE.
CFU_UNDERLINEHAIRLINE	Muestra como CFU_UNDERLINE.
CFU_UNDERLINEHEAVYWAVE	Mostrar como CFU_UNDERLINEWAVE.
CFU_UNDERLINELONGDASH	Muestra como CFU_UNDERLINEDASH.
CFU_UNDERLINENONE	Sin subrayado. Este es el valor predeterminado.
CFU_UNDERLINETHICK	Muestra como CFU_UNDERLINE.
CFU_UNDERLINETHICKDASH	Muestra como CFU_UNDERLINEDASH.
CFU_UNDERLINETHICKDASHDOT	Muestra como CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDASHDOTDOT	Muestra como CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDOTTED	Muestra como CFU_UNDERLINEDOT.
CFU_UNDERLINETHICKLONGDASH	Muestra como CFU_UNDERLINEDASH.
CFU_UNDERLINEWAVE	RichEdit 4.1 y versiones posteriores: texto subrayado con una línea ondulada.
CFU_UNDERLINEWORD	RichEdit 4.1 y versiones posteriores: subrayado solo palabras. El control de edición enriquecido muestra el texto con un subrayado sólido.

bAnimation

Tipo: byte de

Tipo de animación de texto. Este valor no tiene ningún efecto en el texto mostrado por un control de edición enriquecido; se incluye para la compatibilidad con interfaces TOM. Para usar este miembro, establezca la marca CFM_ANIMATION en el miembro dwMask.

bRevAuthor

Tipo: byte de

Índice que identifica al autor que realiza una revisión. El control de edición enriquecida usa colores de texto diferentes para cada índice de autor diferente. Para usar este miembro, establezca la marca CFM_REVAUTHOR en el miembro dwMask .

bUnderlineColor

Tipo: byte de

Color de subrayado:

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;

Observaciones

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 CHARFORMAT2 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows Vista [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows Server 2003 [solo aplicaciones de escritorio]
encabezado de	richedit.h