richedit.h) (CHARFORMAT2A 結構

發行項
03/01/2024

包含豐富編輯控制件中字元格式的相關信息。 CHARFORMAT2 是 CHARFORMAT 結構的 Microsoft Rich Edit 2.0 延伸模組。 Microsoft Rich Edit 2.0 可讓您搭配 EM_GETCHARFORMAT 和 EM_SETCHARFORMAT 訊息使用任一結構。

Syntax

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

繼承

CHARFORMAT2A 結構會實作 _charformat。

成員

wWeight

類型： WORD

字型粗細。這個成員與 LOGFONT 結構的 lfWeight 成員相同。若要使用此成員，請在 dwMask 成員中設定CFM_WEIGHT旗標。

sSpacing

類型： SHORT

字母之間的水準間距，以 twip 為單位。這個值不會影響豐富編輯控件所顯示的文字;隨附於 Windows TOM 介面的相容性。若要使用此成員，請在 dwMask 成員中設定CFM_SPACING旗標。

crBackColor

類型： COLORREF

背景色彩。若要使用此成員，請在 dwMask 成員中設定CFM_BACKCOLOR旗標。如果指定 CFE_AUTOBACKCOLOR 字元效果，則會忽略這個成員。若要產生，請使用宏。

lcid

類型： LCID

32 位地區設定標識碼，其中包含較低字中的語言標識符，以及上一個字中的排序標識碼和保留值。這個成員不會影響豐富編輯控件所顯示的文字，但拼字和文法檢查工具可以使用它來處理與語言相關的問題。您可以使用宏來建立 LCID 值。若要使用此成員，請在 dwMask 成員中設定CFM_LCID旗標。

dwReserved

類型： DWORD

保留;值必須是零。

dwCookie

類型： DWORD

用戶端 Cookie。這個成員對豐富的編輯控件不透明。

sStyle

類型： SHORT

字元樣式句柄。這個值不會影響豐富編輯控件所顯示的文字;隨附於 WindowsTOM 介面的相容性。若要使用此成員，請在 dwMask 成員中設定CFM_STYLE旗標。如需詳細資訊，請參閱 TOM 檔。

wKerning

類型： WORD

字型大小的值，其上方的字元 (yHeight) 。這個值不會影響豐富編輯控件所顯示的文字;它隨附於 TOM 介面的相容性。若要使用此成員，請在 dwMask 成員中設定CFM_KERNING旗標。

bUnderlineType

類型： BYTE

指定底線類型。若要使用此成員，請在 dwMask 成員中設定CFM_UNDERLINETYPE旗標。這個成員可以是下列其中一個值。

值	意義
CFU_CF1UNDERLINE	結構會將 CHARFORMAT 的位底線對應至 CHARFORMAT2， (也就是說，它會在此文字) 上執行 CHARFORMAT 類型的底線。
CFU_INVERT	針對輸入法組合，請假選取專案。
CFU_UNDERLINE	以單一實線加上底線的文字。
CFU_UNDERLINEDASH	以虛線加上底線的文字。
CFU_UNDERLINEDASHDOT	以虛線和虛線加上底線的文字。
CFU_UNDERLINEDASHDOTDOT	以虛線和雙虛線加上底線的文字。
CFU_UNDERLINEDOTTED	以虛線加上底線的文字。對於 Microsoft Rich Edit 3.0 之前的版本，文字會以純底線顯示。
CFU_UNDERLINEDOUBLE	以雙行加上底線的文字。 RTF 編輯控制項會以純底線顯示文字。
CFU_UNDERLINEDOUBLEWAVE	顯示為 CFU_UNDERLINEWAVE。
CFU_UNDERLINEHAIRLINE	顯示為 CFU_UNDERLINE。
CFU_UNDERLINEHEAVYWAVE	顯示為 CFU_UNDERLINEWAVE。
CFU_UNDERLINELONGDASH	顯示為 CFU_UNDERLINEDASH。
CFU_UNDERLINENONE	沒有底線。此為預設值。
CFU_UNDERLINETHICK	顯示為 CFU_UNDERLINE。
CFU_UNDERLINETHICKDASH	顯示為 CFU_UNDERLINEDASH。
CFU_UNDERLINETHICKDASHDOT	顯示為 CFU_UNDERLINEDASHDOT。
CFU_UNDERLINETHICKDASHDOTDOT	顯示為 CFU_UNDERLINEDASHDOT。
CFU_UNDERLINETHICKDOTTED	顯示為 CFU_UNDERLINEDOT。
CFU_UNDERLINETHICKLONGDASH	顯示為 CFU_UNDERLINEDASH。
CFU_UNDERLINEWAVE	RichEdit 4.1 和更新版本：以波浪線加上底線的文字。
CFU_UNDERLINEWORD	RichEdit 4.1 和更新版本：僅加底線字。 RTF 編輯控制項會以純底線顯示文字。

bAnimation

類型： BYTE

文字動畫類型。這個值不會影響豐富編輯控件所顯示的文字;它隨附於 TOM 介面的相容性。若要使用此成員，請在 dwMask 成員中設定CFM_ANIMATION旗標。

bRevAuthor

類型： BYTE

索引，識別製作修訂的作者。 RTF 編輯控制項會針對每個不同的作者索引使用不同的文字色彩。若要使用此成員，請在 dwMask 成員中設定CFM_REVAUTHOR旗標。

bUnderlineColor

類型： BYTE

底線顏色：

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;

備註

若要關閉格式化屬性，請在 dwMask 中設定適當的值，但不在 dwEffects 中設定對應的值。例如，若要關閉斜體，請設定 CFM_ITALIC 但不設定 CFE_ITALIC。

注意

richedit.h 標頭會將 CHARFORMAT2定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
標頭	richedit.h