estructura de CHARFORMAT2W (Rich Edit 2.0)

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 cualquiera de las estructuras con los mensajes EM_GETCHARFORMAT y EM_SETCHARFORMAT .

Sintaxis

typedef struct _charformat2w {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  WCHAR    szFaceName[LF_FACESIZE];
  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;
} CHARFORMAT2W;

Miembros

cbSize

Tipo: UINT

Especifica el tamaño, en bytes, de la estructura. Antes de pasar esta estructura a un control de edición enriquecido, establezca cbSize en el tamaño de CHARFORMAT o CHARFORMAT2 estructura. Si cbSize es igual al tamaño de una estructura CHARFORMAT , el control solo usa los miembros CHARFORMAT .

dwMask

Tipo: DWORD

Especifica las partes de la estructura de CHARFORMAT2 que contienen información válida. El miembro dwMask puede ser una combinación de los valores de dos conjuntos de marcas de bits. Un conjunto indica los miembros de la estructura que son válidos. Otro conjunto indica los atributos válidos en el miembro dwEffects .

Establezca los valores siguientes para indicar los atributos válidos del miembro dwEffects .

Valor Significado
CFM_ALL
Combinación de los siguientes valores: CFM_EFFECTS | CFM_SIZE | CFM_FACE | CFM_OFFSET CFM_CHARSET |
CFM_ALL2
Combinación de los siguientesvalores: CFM_ALL | CFM_EFFECTS2 | CFM_BACKCOLOR CFM_LCID | | CFM_UNDERLINETYPE | | | | | CFM_WEIGHT CFM_REVAUTHOR CFM_SPACINGCFM_KERNING CFM_STYLE | CFM_ANIMATION CFM_COOKIE |
CFM_ALLCAPS
El valor de CFE_ALLCAPS es válido.
CFM_EFFECTS
Combinación de los siguientes valores: CFM_EFFECTS2 CFM_FONTBOUND | | CFM_EXTENDED CFM_MATHNOBUILDUP | | CFM_MATH | CFM_MATHORDINARY
CFM_BOLD
El valor CFE_BOLD es válido.
CFM_COLOR
El valor de CFE_AUTOCOLOR es válido o el miembro crTextColor es válido.
CFM_COOKIE
El valor dwCookie es válido.
CFM_DISABLED
El valor CFE_DISABLED es válido.
CFM_EXTENDED
El valor de CFE_EXTENDED es válido.
CFM_EFFECTS
Combinación de los siguientes valores: CFM_BOLD | CFM_ITALIC | CFM_UNDERLINE CFM_COLOR | | CFM_STRIKEOUT | CFE_PROTECTED | CFM_LINK
CFM_EFFECTS2
Combinación delos siguientes valores:CFM_EFFECTS CFM_DISABLED | | CFM_SMALLCAPS | CFM_ALLCAPS | CFM_HIDDEN | CFM_OUTLINE | | | | CFM_SHADOW CFM_EMBOSS CFM_IMPRINTCFM_REVISED | CFM_SUBSCRIPT | CFM_SUPERSCRIPT CFM_BACKCOLOR |
CFM_EMBOSS
El valor de CFE_EMBOSS es válido.
CFM_FONTBOUND
El valor de CFE_FONTBOUND es válido.
CFM_HIDDEN
El valor de CFE_HIDDEN es válido.
CFM_IMPRINT
El valor de CFE_IMPRINT es válido.
CFM_ITALIC
El valor CFE_ITALIC es válido.
CFM_LINK
El valor de CFE_LINK es válido.
CFM_LINKPROTECTED
El valor de CFE_LINKPROTECTED es válido.
CFM_MATH
El valor de CFE_MATH es válido.
CFM_MATHNOBUILDUP
El valor CFE_MATHNOBUILDUP es válido.
CFM_MATHORDINARY
El valor de CFE_MATHORDINARY es válido.
CFM_OUTLINE
El valor de CFE_OUTLINE es válido.
CFM_PROTECTED
El valor de CFE_PROTECTED es válido.
CFM_REVISED
El valor de CFE_REVISION es válido.
CFM_SHADOW
El valor de CFE_SHADOW es válido.
CFM_SMALLCAPS
El valor de CFE_SMALLCAPS es válido.
CFM_STRIKEOUT
El valor de CFE_STRIKEOUT es válido.
CFM_SUBSCRIPT
Los valores CFE_SUBSCRIPT y CFE_SUPERSCRIPT son válidos.
CFM_SUPERSCRIPT
Los valores CFE_SUBSCRIPT y CFE_SUPERSCRIPT son válidos.
CFM_UNDERLINE
El valor de CFE_UNDERLINE es válido.
 

Establezca los valores siguientes para indicar los miembros de estructura válidos.

Valor Significado
CFM_ANIMATION
El miembro bAnimation es válido.
CFM_BACKCOLOR
El miembro crBackColor es válido.
CFM_CHARSET
El miembro bCharSet es válido.
CFM_COLOR
El miembro crTextColor es válido a menos que la marca CFE_AUTOCOLOR esté establecida en el miembro dwEffects .
CFM_FACE
El miembro szFaceName es válido.
CFM_KERNING
El miembro wKerning es válido.
CFM_LCID
El miembro lcid es válido.
CFM_OFFSET
El miembro yOffset es válido.
CFM_REVAUTHOR
El miembro bRevAuthor es válido.
CFM_SIZE
El miembro yHeight es válido.
CFM_SPACING
El miembro sSpacing es válido.
CFM_STYLE
El miembro sStyle es válido.
CFM_UNDERLINETYPE
El miembro bUnderlineType es válido.
CFM_WEIGHT
El miembro wWeight es válido.

dwEffects

Tipo: DWORD

Conjunto de marcas de bits que especifican efectos de caracteres. Algunas de las marcas solo se incluyen por motivos de compatibilidad con las interfaces del Modelo de objetos de texto de Microsoft (TOM); El control de edición enriquecida almacena el valor, pero no lo usa para mostrar texto.

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

Valor Significado
CFE_ALLCAPS
Los caracteres son letras mayúsculas. El valor no afecta a la forma en que el control muestra el texto. Este valor solo se aplica a las versiones anteriores a Microsoft Rich Edit 3.0.
CFE_AUTOBACKCOLOR
El color de fondo es el valor devuelto de GetSysColor(COLOR_WINDOW). Si se establece esta marca, se omite el miembro crBackColor .
CFE_AUTOCOLOR
El color del texto es el valor devuelto de GetSysColor(COLOR_WINDOWTEXT). Si se establece esta marca, se omite el miembro crTextColor .
CFE_BOLD
Los caracteres están en negrita.
CFE_DISABLED
Los caracteres se muestran con una sombra que se desplaza por 3/4 puntos o un píxel, lo que sea mayor.
CFE_EMBOSS
Los caracteres están en relieve. El valor no afecta al modo en que el control muestra el texto.
CFE_EXTENDED
Los caracteres son miembros menos comunes de un script. Una fuente que admita un script debe comprobar si tiene glifos para estos caracteres.
CFE_FONTBOUND
El control de edición enriquecido elige fuente porque la fuente activa no admite los caracteres. Este proceso se denomina enlace de fuentes.
CFE_HIDDEN
Para Microsoft Rich Edit 3.0 y versiones posteriores, no se muestran los caracteres.
CFE_IMPRINT
Los caracteres se muestran como caracteres impresos. El valor no afecta al modo en que el control muestra el texto.
CFE_ITALIC
Los caracteres son cursiva.
CFE_LINK
Un control de edición enriquecido puede enviar EN_LINK códigos de notificación cuando recibe mensajes del mouse mientras el puntero del mouse está sobre texto con el efecto CFE_LINK .
CFE_LINKPROTECTED
Los caracteres forman parte de un vínculo de nombre descriptivo.
CFE_MATH
Los caracteres están en una zona matemática.
CFE_MATHNOBUILDUP
Los caracteres no participan en una compilación matemática. Por ejemplo, cuando se aplica a /, no se usará / para generar una fracción.
CFE_MATHORDINARY
Los caracteres se muestran como texto normal dentro de una zona matemática.
CFE_OUTLINE
Los caracteres se muestran como caracteres descritos. El valor no afecta al modo en que el control muestra el texto.
CFE_PROTECTED
Los caracteres están protegidos; un intento de modificarlos provocará un código de notificación EN_PROTECTED .
CFE_REVISED
Los caracteres se marcan como revisados.
CFE_SHADOW
Los caracteres se muestran como caracteres sombreados. El valor no afecta al modo en que el control muestra el texto.
CFE_SMALLCAPS
Los caracteres están en minúsculas. El valor no afecta al modo en que el control muestra el texto.
CFE_STRIKEOUT
Los caracteres se golpean.
CFE_SUBSCRIPT
Los caracteres son subíndice. Los valores de CFE_SUPERSCRIPT y CFE_SUBSCRIPT son mutuamente excluyentes. Para ambos valores, el control calcula automáticamente un desplazamiento y un tamaño de fuente más pequeño. Como alternativa, puede usar los miembros yHeight e yOffset para especificar explícitamente el tamaño y el desplazamiento de fuente para los caracteres de subíndice y superíndice.
CFE_SUPERSCRIPT
Los caracteres son superíndice.
CFE_UNDERLINE
Los caracteres están subrayados.

yHeight

Tipo: LONG

Especifica el alto del carácter, en twips (1/1440 de pulgada o 1/20 del punto de una impresora). Para usar este miembro, establezca la marca CFM_SIZE en el miembro dwMask .

yOffset

Tipo: LONG

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

crTextColor

Tipo: COLORREF

Color del texto. Para usar este miembro, establezca la marca CFM_COLOR en el miembro dwMask . Este miembro se omite si se especifica el efecto de CFE_AUTOCOLOR carácter. Para generar un COLORREF, use la macro RGB .

bCharSet

Tipo: BYTE

Valor del juego de caracteres. Puede ser uno de los valores especificados para el miembro lfCharSet de la estructura LOGFONT . Para usar este miembro, establezca la marca CFM_CHARSET en el miembro dwMask .

bPitchAndFamily

Tipo: BYTE

Especifica la familia de fuentes y el 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. Para usar este miembro, establezca la marca CFM_FACE en el miembro dwMask .

wWeight

Tipo: WORD

Peso de fuente. Este miembro es el mismo que el miembro lfWeight de la estructura LOGFONT . 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 CFM_SPACING en el miembro dwMask .

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 CFE_AUTOBACKCOLOR carácter. 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 con problemas dependientes del idioma. Puede usar la macro para crear un valor LCID . Para usar este miembro, establezca la marca CFM_LCID en el miembro dwMask .

dwReserved

Tipo: DWORD

Reservados; el valor debe ser cero.

dwCookie

Tipo: DWORD

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 por 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 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 por motivos de compatibilidad con interfaces TOM. Para usar este miembro, establezca la marca CFM_KERNING en el miembro dwMask .

bUnderlineType

Tipo: BYTE

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

Valor Significado
CFU_CF1UNDERLINE
La estructura asigna el subrayado de bits CHARFORMAT a CHARFORMAT2( es decir, realiza un tipo CHARFORMAT 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
Se muestra como CFU_UNDERLINE.
CFU_UNDERLINEHEAVYWAVE
Mostrar como CFU_UNDERLINEWAVE.
CFU_UNDERLINELONGDASH
Mostrar como CFU_UNDERLINEDASH.
CFU_UNDERLINENONE
Sin subrayado. Este es el valor predeterminado.
CFU_UNDERLINETHICK
Se muestra como CFU_UNDERLINE.
CFU_UNDERLINETHICKDASH
Mostrar como CFU_UNDERLINEDASH.
CFU_UNDERLINETHICKDASHDOT
Mostrar como CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDASHDOTDOT
Mostrar como CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDOTTED
Se muestra como CFU_UNDERLINEDOT.
CFU_UNDERLINETHICKLONGDASH
Mostrar 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

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 por motivos de compatibilidad con interfaces TOM. Para usar este miembro, establezca la marca CFM_ANIMATION en el miembro dwMask .

bRevAuthor

Tipo: BYTE

Í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

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;

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.

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

CHARFORMAT

COLORREF

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

GetSysColor

LOGFONT

RGB