CHARFORMATA 構造体 (richedit.h)

  • [アーティクル]

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

リッチ エディット 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

文字の高さ (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 を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

こちらもご覧ください

CHARFORMAT2

EM_GETCHARFORMAT

EM_SETCHARFORMAT

EN_PROTECTED

参照