Win32 API 日本語リファレンス
ホームUI.Controls.RichEdit › CHARFORMATA

CHARFORMATA

構造体
サイズx64: 60 バイト / x86: 60 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
cbSizeDWORD4+0+0指定する構造体のサイズ (バイト単位)。このメンバーは、構造体をリッチ エディット コントロールに渡す前に設定しておく必要があります。
dwMaskCFM_MASK4+4+4

有効な情報を保持している、または設定対象となる属性を持つメンバーを指定します。このメンバーには、次の値のうち 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 値が有効です。
dwEffectsCFE_EFFECTS4+8+8

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

意味
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 通知コードが送られます。
yHeightINT4+12+12文字の高さを twip 単位 (1/1440 インチ、またはプリンターのポイントの 1/20) で指定します。
yOffsetINT4+16+16ベースラインからの文字のオフセットを twip 単位で指定します。このメンバーの値が正の場合、その文字は上付き文字になり、負の場合は下付き文字になります。
crTextColorCOLORREF4+20+20テキストの色を指定します。CFE_AUTOCOLOR 文字効果が指定されている場合、このメンバーは無視されます。COLORREF を生成するには、RGB マクロを使用します。
bCharSetFONT_CHARSET1+24+24文字セットの値を指定します。 bCharSet メンバーには、LOGFONT 構造体の lfCharSet メンバーに指定できる値のいずれかを指定できます。Microsoft Rich Edit 3.0 では、対象の文字に対してこの値が無効な場合、この値が上書きされることがあります。
bPitchAndFamilyBYTE1+25+25フォントのファミリとピッチを指定します。このメンバーは LOGFONT 構造体の lfPitchAndFamily メンバーと同じです。
szFaceNameCHAR32+26+26フォント名を指定する、NULL で終わる文字配列です。

公式ドキュメント

リッチ エディット コントロールにおける文字書式の情報を格納します。

Rich Edit 2.0: CHARFORMAT2 構造体は、CHARFORMAT 構造体に対する Microsoft Rich Edit 2.0 の拡張です。Microsoft Rich Edit 2.0 以降では、EM_GETCHARFORMAT メッセージおよび EM_SETCHARFORMAT メッセージで、いずれの構造体も使用できます。

解説(Remarks)

書式属性をオフにするには、dwMask で該当する値を設定し、dwEffects では対応する値を設定しないようにします。たとえば、斜体をオフにするには、CFM_ITALIC を設定し、CFE_ITALIC は設定しません。

メモ

richedit.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして CHARFORMAT を定義しています。このエンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイル エラーや実行時エラーの原因になることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// CHARFORMATA  (x64 60 / x86 60 バイト)
typedef struct CHARFORMATA {
    DWORD cbSize;
    CFM_MASK dwMask;
    CFE_EFFECTS dwEffects;
    INT yHeight;
    INT yOffset;
    COLORREF crTextColor;
    FONT_CHARSET bCharSet;
    BYTE bPitchAndFamily;
    CHAR szFaceName[32];
} CHARFORMATA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CHARFORMATA
{
    public uint cbSize;
    public uint dwMask;
    public uint dwEffects;
    public int yHeight;
    public int yOffset;
    public uint crTextColor;
    public byte bCharSet;
    public byte bPitchAndFamily;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 32)] public sbyte[] szFaceName;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CHARFORMATA
    Public cbSize As UInteger
    Public dwMask As UInteger
    Public dwEffects As UInteger
    Public yHeight As Integer
    Public yOffset As Integer
    Public crTextColor As UInteger
    Public bCharSet As Byte
    Public bPitchAndFamily As Byte
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=32)> Public szFaceName() As SByte
End Structure
import ctypes
from ctypes import wintypes

class CHARFORMATA(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("dwMask", wintypes.DWORD),
        ("dwEffects", wintypes.DWORD),
        ("yHeight", ctypes.c_int),
        ("yOffset", ctypes.c_int),
        ("crTextColor", wintypes.DWORD),
        ("bCharSet", ctypes.c_ubyte),
        ("bPitchAndFamily", ctypes.c_ubyte),
        ("szFaceName", ctypes.c_byte * 32),
    ]
#[repr(C)]
pub struct CHARFORMATA {
    pub cbSize: u32,
    pub dwMask: u32,
    pub dwEffects: u32,
    pub yHeight: i32,
    pub yOffset: i32,
    pub crTextColor: u32,
    pub bCharSet: u8,
    pub bPitchAndFamily: u8,
    pub szFaceName: [i8; 32],
}
import "golang.org/x/sys/windows"

type CHARFORMATA struct {
	cbSize uint32
	dwMask uint32
	dwEffects uint32
	yHeight int32
	yOffset int32
	crTextColor uint32
	bCharSet byte
	bPitchAndFamily byte
	szFaceName [32]int8
}
type
  CHARFORMATA = record
    cbSize: DWORD;
    dwMask: DWORD;
    dwEffects: DWORD;
    yHeight: Integer;
    yOffset: Integer;
    crTextColor: DWORD;
    bCharSet: Byte;
    bPitchAndFamily: Byte;
    szFaceName: array[0..31] of Shortint;
  end;
const CHARFORMATA = extern struct {
    cbSize: u32,
    dwMask: u32,
    dwEffects: u32,
    yHeight: i32,
    yOffset: i32,
    crTextColor: u32,
    bCharSet: u8,
    bPitchAndFamily: u8,
    szFaceName: [32]i8,
};
type
  CHARFORMATA {.bycopy.} = object
    cbSize: uint32
    dwMask: uint32
    dwEffects: uint32
    yHeight: int32
    yOffset: int32
    crTextColor: uint32
    bCharSet: uint8
    bPitchAndFamily: uint8
    szFaceName: array[32, int8]
struct CHARFORMATA
{
    uint cbSize;
    uint dwMask;
    uint dwEffects;
    int yHeight;
    int yOffset;
    uint crTextColor;
    ubyte bCharSet;
    ubyte bPitchAndFamily;
    byte[32] szFaceName;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CHARFORMATA サイズ: 60 バイト(x64)
dim st, 15    ; 4byte整数×15(構造体サイズ 60 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : CFM_MASK (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwEffects : CFE_EFFECTS (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; yHeight : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; yOffset : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; crTextColor : COLORREF (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; bCharSet : FONT_CHARSET (+24, 1byte)  poke st,24,値  /  値 = peek(st,24)
; bPitchAndFamily : BYTE (+25, 1byte)  poke st,25,値  /  値 = peek(st,25)
; szFaceName : CHAR (+26, 32byte)  varptr(st)+26 を基点に操作(32byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CHARFORMATA
    #field int cbSize
    #field int dwMask
    #field int dwEffects
    #field int yHeight
    #field int yOffset
    #field int crTextColor
    #field byte bCharSet
    #field byte bPitchAndFamily
    #field byte szFaceName 32
#endstruct

stdim st, CHARFORMATA        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize