CHARFORMAT2W 構造体 (Rich Edit 2.0)

  • [アーティクル]

リッチ エディット コントロールの文字書式に関する情報が含まれています。 CHARFORMAT2 は、 CHARFORMAT 構造体の Microsoft Rich Edit 2.0 拡張機能です。 Microsoft Rich Edit 2.0 では、 メッセージのEM_GETCHARFORMAT と EM_SETCHARFORMAT のいずれかの構造を使用できます。

構文

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;

メンバー

cbSize

型: UINT

構造体のサイズをバイト単位で指定します。 この構造体をリッチ エディット コントロールに渡す前に、 cbSize を CHARFORMAT または CHARFORMAT2 構造体のサイズに設定します。 cbSize がCHARFORMAT 構造体のサイズと等しい場合、コントロールは CHARFORMAT メンバーのみを使用します。

dwMask

型: DWORD

有効な情報を含む CHARFORMAT2 構造体の部分を指定します。 dwMask メンバーには、2 つのビット フラグ セットの値を組み合わせて使用できます。 1 つのセットは、有効な構造体メンバーを示します。 別のセットは、 dwEffects メンバーの有効な属性を示します。

dwEffects メンバーの有効な属性を示すように、次の値を設定します。

値 意味
CFM_ALL
 次の値の組み合わせ: CFM_EFFECTS | CFM_SIZE CFM_FACE | CFM_OFFSET | CFM_CHARSET |
CFM_ALL2
 次の値の組み合わせ: CFM_ALL CFM_EFFECTS2 | CFM_BACKCOLOR | CFM_LCID CFM_UNDERLINETYPE | CFM_WEIGHT CFM_REVAUTHOR | CFM_SPACING | CFM_KERNING | | CFM_STYLE | | CFM_ANIMATION | | CFM_ANIMATION CFM_COOKIE
CFM_ALLCAPS
 CFE_ALLCAPS値は有効です。
CFM_EFFECTS
 次の値の組み合わせ: CFM_EFFECTS2 | CFM_FONTBOUND CFM_EXTENDED | CFM_MATHNOBUILDUP | CFM_MATH | CFM_MATHORDINARY |
CFM_BOLD
 CFE_BOLD値は有効です。
CFM_COLOR
 CFE_AUTOCOLOR値が有効であるか、crTextColor メンバーが有効です。
CFM_COOKIE
 dwCookie 値は有効です。
CFM_DISABLED
 CFE_DISABLED値は有効です。
CFM_EXTENDED
 CFE_EXTENDED値は有効です。
CFM_EFFECTS
 次の値の組み合わせ: CFM_STRIKEOUT | CFE_PROTECTED CFM_LINK | CFM_COLOR | CFM_UNDERLINE | CFM_ITALIC | CFM_BOLD |
CFM_EFFECTS2
 次の値の組み合わせ: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_EFFECTS
CFM_EMBOSS
 CFE_EMBOSS値は有効です。
CFM_FONTBOUND
 CFE_FONTBOUND値は有効です。
CFM_HIDDEN
 CFE_HIDDEN値は有効です。
CFM_IMPRINT
 CFE_IMPRINT値は有効です。
CFM_ITALIC
 CFE_ITALIC値は有効です。
CFM_LINK
 CFE_LINK値は有効です。
CFM_LINKPROTECTED
 CFE_LINKPROTECTED値は有効です。
CFM_MATH
 CFE_MATH値は有効です。
CFM_MATHNOBUILDUP
 CFE_MATHNOBUILDUP値は有効です。
CFM_MATHORDINARY
 CFE_MATHORDINARY値は有効です。
CFM_OUTLINE
 CFE_OUTLINE値は有効です。
CFM_PROTECTED
 CFE_PROTECTED値は有効です。
CFM_REVISED
 CFE_REVISION値は有効です。
CFM_SHADOW
 CFE_SHADOW値は有効です。
CFM_SMALLCAPS
 CFE_SMALLCAPS値は有効です。
CFM_STRIKEOUT
 CFE_STRIKEOUT値は有効です。
CFM_SUBSCRIPT
 CFE_SUBSCRIPTとCFE_SUPERSCRIPTの値が有効です。
CFM_SUPERSCRIPT
 CFE_SUBSCRIPTとCFE_SUPERSCRIPTの値が有効です。
CFM_UNDERLINE
 CFE_UNDERLINE値は有効です。
 

有効な構造体メンバーを示すには、次の値を設定します。

値 意味
CFM_ANIMATION
 bAnimation メンバーは有効です。
CFM_BACKCOLOR
 crBackColor メンバーは有効です。
CFM_CHARSET
 bCharSet メンバーは有効です。
CFM_COLOR
 crTextColor メンバーは、dwEffects メンバーでCFE_AUTOCOLOR フラグが設定されていない限り有効です。
CFM_FACE
 szFaceName メンバーは有効です。
CFM_KERNING
 wKerning メンバーは有効です。
CFM_LCID
 lcid メンバーは有効です。
CFM_OFFSET
 yOffset メンバーは有効です。
CFM_REVAUTHOR
 bRevAuthor メンバーは有効です。
CFM_SIZE
 yHeight メンバーは有効です。
CFM_SPACING
 sSpacing メンバーは有効です。
CFM_STYLE
 sStyle メンバーは有効です。
CFM_UNDERLINETYPE
 bUnderlineType メンバーは有効です。
CFM_WEIGHT
 wWeight メンバーは有効です。

dwEffects

型: DWORD

文字効果を指定するビット フラグのセット。 一部のフラグは、Microsoft Text Object Model (TOM) インターフェイスとの互換性のためにのみ含まれています。リッチ エディット コントロールは値を格納しますが、テキストの表示には使用しません。

このメンバーには、次の値の組み合わせを指定できます。

値 意味
CFE_ALLCAPS
 文字はすべて大文字です。 この値は、コントロールのテキストの表示方法には影響しません。 この値は、Microsoft Rich Edit 3.0 より前のバージョンにのみ適用されます。
CFE_AUTOBACKCOLOR
 背景色は GetSysColor(COLOR_WINDOW) の戻り値です。 このフラグが設定されている場合、 crBackColor メンバーは無視されます。
CFE_AUTOCOLOR
 テキストの色は GetSysColor(COLOR_WINDOWTEXT) の戻り値です。 このフラグが設定されている場合、 crTextColor メンバーは無視されます。
CFE_BOLD
 文字は太字です。
CFE_DISABLED
 文字は影付きで表示され、3/4 ポイントまたは 1 ピクセル(どちらか大きい方)でオフセットされます。
CFE_EMBOSS
 文字はエンボス加工されます。 この値は、コントロールによるテキストの表示方法には影響しません。
CFE_EXTENDED
 これらの文字は、スクリプトのあまり一般的でないメンバーです。 スクリプトをサポートするフォントは、そのような文字のグリフがある場合にチェックする必要があります。
CFE_FONTBOUND
 アクティブなフォントでは文字がサポートされていないため、リッチ エディット コントロールによってフォントが選択されます。 このプロセスは、フォント バインドと呼ばれます。
CFE_HIDDEN
 Microsoft Rich Edit 3.0 以降では、文字は表示されません。
CFE_IMPRINT
 文字はインプリント文字として表示されます。 この値は、コントロールによるテキストの表示方法には影響しません。
CFE_ITALIC
 文字は斜体です。
CFE_LINK
 リッチ エディット コントロールは、 マウス ポインターがCFE_LINK 効果を持つテキストの上にある間に、マウス メッセージを受信したときに EN_LINK 通知コードを送信できます。
CFE_LINKPROTECTED
 文字は、フレンドリ名リンクの一部です。
CFE_MATH
 文字は数学領域にあります。
CFE_MATHNOBUILDUP
 文字は数学のビルドアップには参加しません。 たとえば、 /に適用した場合、 / は分数を構築するために使用されません。
CFE_MATHORDINARY
 文字は、数値演算領域内で通常のテキストとして表示されます。
CFE_OUTLINE
 文字はアウトライン文字として表示されます。 この値は、コントロールによるテキストの表示方法には影響しません。
CFE_PROTECTED
 文字は保護されています。変更しようとすると、 EN_PROTECTED 通知コードが発生します。
CFE_REVISED
 文字は変更済みとしてマークされます。
CFE_SHADOW
 文字は影付き文字として表示されます。 この値は、コントロールによるテキストの表示方法には影響しません。
CFE_SMALLCAPS
 文字は小文字です。 この値は、コントロールによるテキストの表示方法には影響しません。
CFE_STRIKEOUT
 文字が三振されます。
CFE_SUBSCRIPT
 文字は下付き文字です。 CFE_SUPERSCRIPTとCFE_SUBSCRIPTの値は相互に排他的です。 両方の値について、コントロールはオフセットと小さいフォント サイズを自動的に計算します。 または、 yHeight メンバーと yOffset メンバーを使用して、下付き文字と上付き文字のフォント サイズとオフセットを明示的に指定することもできます。
CFE_SUPERSCRIPT
 文字は上付き文字です。
CFE_UNDERLINE
 文字には下線が付いている。

yHeight

型: LONG

文字の高さを twip 単位で指定します (1/1440 インチ、またはプリンターのポイントの 1/20)。 このメンバーを使用するには、dwMask メンバーで CFM_SIZE フラグを設定します。

yOffset

型: LONG

ベースラインからの文字オフセット (twip 単位)。 このメンバーの値が正の場合、文字は上付き文字になります。値が負の場合、文字は添字になります。 このメンバーを使用するには、dwMask メンバーで CFM_OFFSET フラグを設定します。

crTextColor

種類: COLORREF

テキストの色。 このメンバーを使用するには、dwMask メンバーに CFM_COLOR フラグを設定します。 CFE_AUTOCOLOR文字効果が指定されている場合、このメンバーは無視されます。 COLORREF を生成するには、RGB マクロを使用します。

bCharSet

型: BYTE

文字セット値。 LOGFONT 構造体の lfCharSet メンバーに指定された値のいずれかを指定できます。 このメンバーを使用するには、dwMask メンバーで CFM_CHARSET フラグを設定します。

bPitchAndFamily

型: BYTE

フォント ファミリとピッチを指定します。 このメンバーは、LOGFONT 構造体の lfPitchAndFamily メンバーと同じです。

szFaceName[LF_FACESIZE]

種類: TCHAR[LF_FACESIZE]

フォント名を指定する null で終わる文字配列。 このメンバーを使用するには、dwMask メンバーに CFM_FACE フラグを設定します。

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

予約;値は 0 である必要があります。

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
 IME コンポジションの場合は、選択内容を偽にします。
CFU_UNDERLINE
 単一の実線で下線が引かれたテキスト。
CFU_UNDERLINEDASH
 ダッシュで下線が付いたテキスト。
CFU_UNDERLINEDASHDOT
 点線と点線で下線が付いたテキスト。
CFU_UNDERLINEDASHDOTDOT
 点線と二重点線で下線が付いたテキスト。
CFU_UNDERLINEDOTTED
 点線で下線が付いたテキスト。 Microsoft Rich Edit 3.0 より前のバージョンの場合、テキストは実線で表示されます。
CFU_UNDERLINEDOUBLE
 二重線で下線が引かれたテキスト。 リッチ エディット コントロールでは、テキストに下線が実線で表示されます。
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 以降: 下線付き単語のみ。 リッチ エディット コントロールでは、テキストに下線が実線で表示されます。

bAnimation

型: BYTE

テキスト アニメーションの種類。 この値は、リッチ エディット コントロールによって表示されるテキストには影響しません。TOM インターフェイスとの互換性のために含まれています。 このメンバーを使用するには、dwMask メンバーで CFM_ANIMATION フラグを設定します。

bRevAuthor

型: BYTE

リビジョンを作成する作成者を識別するインデックス。 リッチ エディット コントロールでは、作成者インデックスごとに異なるテキストの色が使用されます。 このメンバーを使用するには、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は設定しません。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
Header richedit.h

こちらもご覧ください

Charformat

COLORREF

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

GetSysColor

Logfont

RGB