struttura CHARFORMAT2W (Rich Edit 2.0)

Articolo
08/15/2024

Contiene informazioni sulla formattazione dei caratteri in un controllo di modifica rtf. CHARFORMAT2 è un'estensione Microsoft Rich Edit 2.0 della struttura CHARFORMAT . Microsoft Rich Edit 2.0 consente di usare una delle due strutture con i messaggi EM_GETCHARFORMAT e EM_SETCHARFORMAT.

Sintassi

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;

Membri

cbSize

Tipo: UINT

Specifica le dimensioni, in byte, della struttura. Prima di passare questa struttura a un controllo di modifica avanzato, impostare cbSize sulle dimensioni della struttura CHARFORMAT o CHARFORMAT2. Se cbSize è uguale alla dimensione di una struttura CHARFORMAT , il controllo utilizza solo i membri CHARFORMAT.

dwMask

Tipo: DWORD

Specifica le parti della struttura CHARFORMAT2 che contengono informazioni valide. Il membro dwMask può essere una combinazione dei valori di due set di flag di bit. Un set indica i membri della struttura validi. Un altro set indica gli attributi validi nel membro dwEffects.

Impostare i valori seguenti per indicare gli attributi validi del membro dwEffects.

Valore	Significato
CFM_ALL	Combinazione dei valori seguenti: CFM_EFFECTS \| CFM_SIZE \| CFM_FACE \| CFM_OFFSET \| CFM_CHARSET
CFM_ALL2	Combinazione dei valori seguenti: CFM_ALL \| CFM_EFFECTS2 \| CFM_BACKCOLOR \| CFM_LCID \| CFM_UNDERLINETYPE \| CFM_WEIGHT \| CFM_REVAUTHOR \| CFM_SPACING \| CFM_KERNING \| CFM_STYLE \| CFM_ANIMATION \| CFM_COOKIE
CFM_ALLCAPS	Il valore CFE_ALLCAPS è valido.
CFM_EFFECTS	Combinazione dei valori seguenti: CFM_EFFECTS2 \| CFM_FONTBOUND \| CFM_EXTENDED \| CFM_MATHNOBUILDUP \| CFM_MATH \| CFM_MATHORDINARY
CFM_BOLD	Il valore CFE_BOLD è valido.
CFM_COLOR	Il valore CFE_AUTOCOLOR è valido oppure il membro crTextColor è valido.
CFM_COOKIE	Il valore di dwCookie è valido.
CFM_DISABLED	Il valore CFE_DISABLED è valido.
CFM_EXTENDED	Il valore CFE_EXTENDED è valido.
CFM_EFFECTS	Combinazione dei valori seguenti: CFM_BOLD \| CFM_ITALIC \| CFM_UNDERLINE \| CFM_COLOR \| CFM_STRIKEOUT \| CFE_PROTECTED \| CFM_LINK
CFM_EFFECTS2	Combinazione dei valori seguenti: CFM_EFFECTS \| CFM_DISABLED \| CFM_SMALLCAPS \| CFM_ALLCAPS \| CFM_HIDDEN \| CFM_OUTLINE \| CFM_SHADOW \| CFM_EMBOSS \| CFM_IMPRINT \| CFM_REVISED \| CFM_SUBSCRIPT \| CFM_SUPERSCRIPT \| CFM_BACKCOLOR
CFM_EMBOSS	Il valore CFE_EMBOSS è valido.
CFM_FONTBOUND	Il valore CFE_FONTBOUND è valido.
CFM_HIDDEN	Il valore CFE_HIDDEN è valido.
CFM_IMPRINT	Il valore CFE_IMPRINT è valido.
CFM_ITALIC	Il valore CFE_ITALIC è valido.
CFM_LINK	Il valore CFE_LINK è valido.
CFM_LINKPROTECTED	Il valore CFE_LINKPROTECTED è valido.
CFM_MATH	Il valore CFE_MATH è valido.
CFM_MATHNOBUILDUP	Il valore CFE_MATHNOBUILDUP è valido.
CFM_MATHORDINARY	Il valore CFE_MATHORDINARY è valido.
CFM_OUTLINE	Il valore CFE_OUTLINE è valido.
CFM_PROTECTED	Il valore CFE_PROTECTED è valido.
CFM_REVISED	Il valore CFE_REVISION è valido.
CFM_SHADOW	Il valore CFE_SHADOW è valido.
CFM_SMALLCAPS	Il valore CFE_SMALLCAPS è valido.
CFM_STRIKEOUT	Il valore CFE_STRIKEOUT è valido.
CFM_SUBSCRIPT	I valori CFE_SUBSCRIPT e CFE_SUPERSCRIPT sono validi.
CFM_SUPERSCRIPT	I valori CFE_SUBSCRIPT e CFE_SUPERSCRIPT sono validi.
CFM_UNDERLINE	Il valore CFE_UNDERLINE è valido.

Impostare i valori seguenti per indicare i membri della struttura validi.

Valore	Significato
CFM_ANIMATION	Il membro bAnimation è valido.
CFM_BACKCOLOR	Il membro crBackColor è valido.
CFM_CHARSET	Il membro bCharSet è valido.
CFM_COLOR	Il membro crTextColor è valido a meno che il flag di CFE_AUTOCOLOR non sia impostato nel membro dwEffects.
CFM_FACE	Il membro szFaceName è valido.
CFM_KERNING	Il membro wKerning è valido.
CFM_LCID	Il membro lcid è valido.
CFM_OFFSET	Il membro yOffset è valido.
CFM_REVAUTHOR	Il membro bRevAuthor è valido.
CFM_SIZE	Il membro yHeight è valido.
CFM_SPACING	Il membro sSpacing è valido.
CFM_STYLE	Il membro sStyle è valido.
CFM_UNDERLINETYPE	Il membro bUnderlineType è valido.
CFM_WEIGHT	Il membro wWeight è valido.

dwEffects

Tipo: DWORD

Set di flag di bit che specificano effetti carattere. Alcuni flag sono inclusi solo per la compatibilità con le interfacce Microsoft Text Object Model (TOM); Il controllo rich edit archivia il valore, ma non lo usa per visualizzare il testo.

Questo membro può essere una combinazione dei valori seguenti.

Valore	Significato
CFE_ALLCAPS	I caratteri sono lettere maiuscole. Il valore non influisce sul modo in cui il controllo visualizza il testo. Questo valore si applica solo alle versioni precedenti a Microsoft Rich Edit 3.0.
CFE_AUTOBACKCOLOR	Il colore di sfondo è il valore restituito di GetSysColor(COLOR_WINDOW). Se questo flag è impostato, membro crBackColor viene ignorato.
CFE_AUTOCOLOR	Il colore del testo è il valore restituito di GetSysColor(COLOR_WINDOWTEXT). Se questo flag è impostato, il membro crTextColor viene ignorato.
CFE_BOLD	I caratteri sono in grassetto.
CFE_DISABLED	I caratteri vengono visualizzati con un'ombreggiatura sfalsato di 3/4 punti o un pixel, a differenza di un pixel maggiore.
CFE_EMBOSS	I caratteri sono in rilievo. Il valore non influisce sul modo in cui il controllo visualizza il testo.
CFE_EXTENDED	I caratteri sono membri meno comuni di uno script. Un tipo di carattere che supporta uno script deve verificare se contiene glifi per tali caratteri.
CFE_FONTBOUND	Il tipo di carattere viene scelto dal controllo rich edit perché il tipo di carattere attivo non supporta i caratteri. Questo processo è denominato associazione di tipi di carattere.
CFE_HIDDEN	Per Microsoft Rich Edit 3.0 e versioni successive, i caratteri non vengono visualizzati.
CFE_IMPRINT	I caratteri vengono visualizzati come caratteri stampati. Il valore non influisce sul modo in cui il controllo visualizza il testo.
CFE_ITALIC	I caratteri sono in corsivo.
CFE_LINK	Un controllo di modifica avanzato può inviare EN_LINK codici di notifica quando riceve messaggi del mouse mentre il puntatore del mouse è posizionato sul testo con l'effetto CFE_LINK.
CFE_LINKPROTECTED	I caratteri fanno parte di un collegamento di nome descrittivo.
CFE_MATH	I caratteri si trovano in una zona matematica.
CFE_MATHNOBUILDUP	I caratteri non partecipano a una compilazione matematica. Ad esempio, se applicato a /, l'oggetto / non verrà usato per creare una frazione.
CFE_MATHORDINARY	I caratteri vengono visualizzati come testo ordinario all'interno di una zona matematica.
CFE_OUTLINE	I caratteri vengono visualizzati come caratteri delineati. Il valore non influisce sul modo in cui il controllo visualizza il testo.
CFE_PROTECTED	I caratteri sono protetti; Un tentativo di modificarli causerà un codice di notifica EN_PROTECTED.
CFE_REVISED	I caratteri vengono contrassegnati come modificati.
CFE_SHADOW	I caratteri vengono visualizzati come caratteri ombreggiati. Il valore non influisce sul modo in cui il controllo visualizza il testo.
CFE_SMALLCAPS	I caratteri sono in lettere maiuscole. Il valore non influisce sul modo in cui il controllo visualizza il testo.
CFE_STRIKEOUT	I caratteri vengono evidenziati.
CFE_SUBSCRIPT	I caratteri sono pedice. I valori CFE_SUPERSCRIPT e CFE_SUBSCRIPT si escludono a vicenda. Per entrambi i valori, il controllo calcola automaticamente un offset e una dimensione inferiore del carattere. In alternativa, è possibile utilizzare il yHeight e membri yOffset per specificare in modo esplicito le dimensioni e l'offset del carattere per i caratteri pedice e apice.
CFE_SUPERSCRIPT	I caratteri sono apice.
CFE_UNDERLINE	I caratteri sono sottolineati.

yHeight

Tipo: LONG

Specifica l'altezza del carattere, espressa in twip (1/1440 di pollice o 1/20 del punto di una stampante). Per utilizzare questo membro, impostare il flag CFM_SIZE nel membro dwMask.

yOffset

Tipo: LONG

Offset di caratteri dalla linea di base, in twip. Se il valore di questo membro è positivo, il carattere è un apice; se il valore è negativo, il carattere è un pedice. Per utilizzare questo membro, impostare il flag di CFM_OFFSET nel membro dwMask .

crTextColor

Tipo: COLORREF

Colore del testo. Per utilizzare questo membro, impostare il flag di CFM_COLOR nel membro dwMask. Questo membro viene ignorato se viene specificato l'effetto carattere CFE_AUTOCOLOR. Per generare un COLORREF, utilizzare la macro RGB .

bCharSet

Tipo: BYTE

Valore del set di caratteri. Può essere uno dei valori specificati per il membro lfCharSet della struttura LOGFONT . Per utilizzare questo membro, impostare il flag di CFM_CHARSET nel membro dwMask .

bPitchAndFamily

Tipo: BYTE

Specifica la famiglia di caratteri e il passo. Questo membro corrisponde al membro lfPitchAndFamily della struttura LOGFONT.

szFaceName[LF_FACESIZE]

Tipo: TCHAR[LF_FACESIZE]

Matrice di caratteri con terminazione Null che specifica il nome del tipo di carattere. Per utilizzare questo membro, impostare il flag di CFM_FACE nel membro dwMask .

wWeight

Tipo: WORD

Spessore del carattere. Questo membro corrisponde al membro lfWeight della struttura LOGFONT . Per utilizzare questo membro, impostare il flag di CFM_WEIGHT nel membro dwMask.

sSpacing

Tipo: SHORT

Spazio orizzontale tra lettere, in twip. Questo valore non ha alcun effetto sul testo visualizzato da un controllo di modifica rtf; è incluso per la compatibilità con le interfacce TOM di Windows. Per utilizzare questo membro, impostare il flag di CFM_SPACING nel membro dwMask.

crBackColor

Tipo: COLORREF

Colore di sfondo. Per usare questo membro, impostare il flag di CFM_BACKCOLOR nel membro dwMask. Questo membro viene ignorato se viene specificato l'effetto carattere CFE_AUTOBACKCOLOR. Per generare un oggetto , utilizzare la macro .

lcid

Tipo: LCID

Identificatore delle impostazioni locali a 32 bit che contiene un identificatore di lingua nella parola inferiore e un identificatore di ordinamento e un valore riservato nella parola superiore. Questo membro non ha alcun effetto sul testo visualizzato da un controllo di modifica avanzato, ma i correttori ortografici e grammaticali possono usarlo per gestire i problemi dipendenti dalla lingua. È possibile utilizzare la macro per creare un valore LCID. Per usare questo membro, impostare il flag di CFM_LCID nel membro dwMask .

dwReserved

Tipo: DWORD

Riservato; il valore deve essere zero.

dwCookie

Tipo: DWORD

Cookie client. Questo membro è opaco per un controllo di modifica avanzato.

sStyle

Tipo: SHORT

Handle di stile carattere. Questo valore non ha alcun effetto sul testo visualizzato da un controllo di modifica rtf; è incluso per la compatibilità con le interfacce WindowsTOM. Per usare questo membro, impostare il flag di CFM_STYLE nel membro dwMask. Per altre informazioni, vedere la documentazione di TOM.

wKerning

Tipo: WORD

Valore della dimensione del carattere, al di sopra del quale creare il carattere (yHeight). Questo valore non ha alcun effetto sul testo visualizzato da un controllo di modifica rtf; è incluso per la compatibilità con le interfacce TOM. Per utilizzare questo membro, impostare il flag di CFM_KERNING nel membro dwMask.

bUnderlineType

Tipo: BYTE

Specifica il tipo di sottolineatura. Per utilizzare questo membro, impostare il flag di CFM_UNDERLINETYPE nel membro dwMask. Questo membro può essere uno dei valori seguenti.

Valore	Significato
CFU_CF1UNDERLINE	La struttura esegue il mapping sottolineatura bit di CHARFORMATa CHARFORMAT2, ovvero esegue un charFORMAT tipo di sottolineatura in questo testo.
CFU_INVERT	Per la composizione IME, falso una selezione.
CFU_UNDERLINE	Testo sottolineato con una singola linea continua.
CFU_UNDERLINEDASH	Testo sottolineato con trattini.
CFU_UNDERLINEDASHDOT	Testo sottolineato con una linea tratteggiata e tratteggiata.
CFU_UNDERLINEDASHDOTDOT	Testo sottolineato con una linea tratteggiata e tratteggiata doppia.
CFU_UNDERLINEDOTTED	Testo sottolineato con una linea tratteggiata. Per le versioni precedenti a Microsoft Rich Edit 3.0, il testo viene visualizzato con una sottolineatura continua.
CFU_UNDERLINEDOUBLE	Testo sottolineato con una doppia riga. Il controllo rich edit visualizza il testo con una sottolineatura continua.
CFU_UNDERLINEDOUBLEWAVE	Visualizza come CFU_UNDERLINEWAVE.
CFU_UNDERLINEHAIRLINE	Visualizza come CFU_UNDERLINE.
CFU_UNDERLINEHEAVYWAVE	Visualizza come CFU_UNDERLINEWAVE.
CFU_UNDERLINELONGDASH	Visualizza come CFU_UNDERLINEDASH.
CFU_UNDERLINENONE	Nessuna sottolineatura. Si tratta dell'impostazione predefinita.
CFU_UNDERLINETHICK	Visualizza come CFU_UNDERLINE.
CFU_UNDERLINETHICKDASH	Visualizza come CFU_UNDERLINEDASH.
CFU_UNDERLINETHICKDASHDOT	Visualizza come CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDASHDOTDOT	Visualizza come CFU_UNDERLINEDASHDOT.
CFU_UNDERLINETHICKDOTTED	Visualizza come CFU_UNDERLINEDOT.
CFU_UNDERLINETHICKLONGDASH	Visualizza come CFU_UNDERLINEDASH.
CFU_UNDERLINEWAVE	RichEdit 4.1 e versioni successive: testo sottolineato con una linea ondulata.
CFU_UNDERLINEWORD	RichEdit 4.1 e versioni successive: sottolinea solo le parole. Il controllo rich edit visualizza il testo con una sottolineatura continua.

bAnimation

Tipo: BYTE

Tipo di animazione di testo. Questo valore non ha alcun effetto sul testo visualizzato da un controllo di modifica rtf; è incluso per la compatibilità con le interfacce TOM. Per usare questo membro, impostare il flag di CFM_ANIMATION nel membro dwMask.

bRevAuthor

Tipo: BYTE

Indice che identifica l'autore che effettua una revisione. Il controllo rich edit utilizza colori di testo diversi per ogni indice dell'autore diverso. Per usare questo membro, impostare il flag di CFM_REVAUTHOR nel membro dwMask.

bUnderlineColor

Tipo: BYTE

Colore sottolineatura:

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;

Osservazioni

Per disattivare un attributo di formattazione, impostare il valore appropriato in dwMask ma non impostare il valore corrispondente in dwEffects. Ad esempio, per disattivare il corsivo, impostare CFM_ITALIC ma non impostare CFE_ITALIC.