CHARFORMATA 構造体 (richedit.h)

  • [アーティクル]

リッチ エディット コントロールの文字書式に関する情報が含まれています。

Rich Edit 2.0:CHARFORMAT2 構造体は、CHARFORMAT 構造体の Microsoft Rich Edit 2.0 拡張機能です。 Microsoft Rich Edit 2.0 以降では、EM_GETCHARFORMAT メッセージと EM_SETCHARFORMAT メッセージのどちらの構造でも使用できます。

構文

typedef struct _charformat {
  UINT     cbSize;
  DWORD    dwMask;
  DWORD    dwEffects;
  LONG     yHeight;
  LONG     yOffset;
  COLORREF crTextColor;
  BYTE     bCharSet;
  BYTE     bPitchAndFamily;
  char     szFaceName[LF_FACESIZE];
} CHARFORMATA;

メンバーズ

cbSize

型: UINT

指定した構造体のサイズ (バイト単位)。 このメンバーは、リッチ エディット コントロールに構造体を渡す前に設定する必要があります。

dwMask

型: DWORD

設定する有効な情報または属性を含むメンバー。 このメンバーには、次の値のうち 0、1、または複数の値を指定できます。

価値 意味
CFM_ALL
 Windows 8: 次の値の組み合わせ: CFM_EFFECTS |CFM_SIZE |CFM_FACE |CFM_OFFSET |CFM_CHARSET
CFM_BOLD
 dwEffects メンバーのCFE_BOLD値が有効です。
CFM_CHARSET
 bCharSet メンバーが有効です。
CFM_COLOR
 crTextColor メンバーと、dwEffects メンバーのCFE_AUTOCOLOR値が有効です。
CFM_EFFECTS
 Windows 8: 次の値の組み合わせ: CFM_BOLD |CFM_ITALIC |CFM_UNDERLINE |CFM_COLOR |CFM_STRIKEOUT |CFE_PROTECTED |CFM_LINK
CFM_FACE
 szFaceName メンバーが有効です。
CFM_ITALIC
 dwEffects メンバーのCFE_ITALIC値が有効です。
CFM_OFFSET
 yOffset メンバーが有効です。
CFM_PROTECTED
 dwEffects メンバーのCFE_PROTECTED値が有効です。
CFM_SIZE
 yHeight メンバーは有効です。
CFM_STRIKEOUT
 dwEffects メンバーのCFE_STRIKEOUT値が有効です。
CFM_UNDERLINE。
 dwEffects メンバーのCFE_UNDERLINE値が有効です。

dwEffects

型: DWORD

文字効果。 このメンバーは、次の値の組み合わせにすることができます。

価値 意味
CFE_AUTOCOLOR
 テキストの色は、GetSysColor(COLOR_WINDOWTEXT) 戻り値です。
CFE_BOLD
 文字は太字です。
CFE_DISABLED
 RichEdit 2.0 以降: 文字は、3/4 ポイントまたは 1 ピクセルのどちらか大きい方でオフセットされた影で表示されます。
CFE_ITALIC
 文字は斜体です。
CFE_STRIKEOUT
 文字が打たれている。
CFE_UNDERLINE
 文字には下線が付けられます。
CFE_PROTECTED
 文字は保護されています。変更しようとすると、EN_PROTECTED 通知コードが発生します。

yHeight

型: long

文字の高さ (twip 単位) (1/1440 インチまたはプリンターのポイントの 1/20)。

yOffset

型: long

ベースラインからの文字オフセット (twip 単位)。 このメンバーの値が正の場合、文字は上付き文字です。負の値の場合、文字は下付き文字です。

crTextColor

型: COLORREF

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

bCharSet

型: BYTE

文字セット値。 bCharSet メンバーには、LOGFONT 構造体の lfCharSet メンバーに指定された値のいずれかを指定できます。 ターゲット文字に対して無効な場合、Microsoft Rich Edit 3.0 によってこの値がオーバーライドされる場合があります。

bPitchAndFamily

型: BYTE

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

szFaceName[LF_FACESIZE]

型: TCHAR[LF_FACESIZE]

フォント名を指定する null で終わる文字配列。

備考

書式設定属性をオフにするには、dwMask で適切な値を設定しますが、dwEffectsで対応する値を設定しないでください。 たとえば、斜体をオフにするには、CFM_ITALIC設定しますが、CFE_ITALICは設定しません。

手記

richedit.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして CHARFORMAT を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルまたは実行時エラーが発生する不一致につながる可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

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

関連項目

CHARFORMAT2

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

リファレンス