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

CHARFORMAT2A

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

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

フィールド

フィールドサイズx64x86説明
BaseCHARFORMATA60+0+0
wWeightWORD2+60+60フォントの太さです。このメンバーは、LOGFONT 構造体の lfWeight メンバーと同じです。このメンバーを使用するには、dwMask メンバーに CFM_WEIGHT フラグを設定します。
sSpacingSHORT2+62+62文字間の水平方向の間隔 (twip 単位)。この値は、リッチ エディット コントロールが表示するテキストには影響しません。Windows TOM インターフェイスとの互換性のために含まれています。このメンバーを使用するには、dwMask メンバーに CFM_SPACING フラグを設定します。
crBackColorCOLORREF4+64+64背景色です。このメンバーを使用するには、dwMask メンバーに CFM_BACKCOLOR フラグを設定します。CFE_AUTOBACKCOLOR 文字効果が指定されている場合、このメンバーは無視されます。COLORREF を生成するには、RGB マクロを使用します。
lcidDWORD4+68+68下位ワードに言語識別子を、上位ワードに並べ替え識別子と予約値を含む 32 ビットのロケール識別子です。このメンバーは、リッチ エディット コントロールが表示するテキストには影響しませんが、スペル チェッカーや文法チェッカーが言語依存の問題を扱うために使用できます。LCID 値を作成するには、MAKELCID マクロを使用できます。このメンバーを使用するには、dwMask メンバーに CFM_LCID フラグを設定します。
Anonymous_Anonymous_e__Union4+72+72
sStyleSHORT2+76+76文字スタイルのハンドルです。この値は、リッチ エディット コントロールが表示するテキストには影響しません。Windows TOM インターフェイスとの互換性のために含まれています。このメンバーを使用するには、dwMask メンバーに CFM_STYLE フラグを設定します。詳細については、TOM のドキュメントを参照してください。
wKerningWORD2+78+78カーニングを行う下限となるフォント サイズ (yHeight) の値です。この値は、リッチ エディット コントロールが表示するテキストには影響しません。TOM インターフェイスとの互換性のために含まれています。このメンバーを使用するには、dwMask メンバーに CFM_KERNING フラグを設定します。
bUnderlineTypeBYTE1+80+80

下線の種類を指定します。このメンバーを使用するには、dwMask メンバーに CFM_UNDERLINETYPE フラグを設定します。このメンバーには、次のいずれかの値を指定できます。

意味
CFU_CF1UNDERLINE
この構造体は、CHARFORMAT のビット下線を CHARFORMAT2 にマップします (つまり、このテキストに CHARFORMAT 形式の下線を適用します)。
CFU_INVERT
IME 変換のために、選択状態を擬似的に表示します。
CFU_UNDERLINE
1 本の実線で下線が引かれます。
CFU_UNDERLINEDASH
破線で下線が引かれます。
CFU_UNDERLINEDASHDOT
一点鎖線 (破線と点) で下線が引かれます。
CFU_UNDERLINEDASHDOTDOT
二点鎖線 (破線と 2 つの点) で下線が引かれます。
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 以降: 単語のみに下線が引かれます。リッチ エディット コントロールは、実線の下線でテキストを表示します。
bAnimationBYTE1+81+81テキストのアニメーションの種類です。この値は、リッチ エディット コントロールが表示するテキストには影響しません。TOM インターフェイスとの互換性のために含まれています。このメンバーを使用するには、dwMask メンバーに CFM_ANIMATION フラグを設定します。
bRevAuthorBYTE1+82+82変更を行った作成者を識別するインデックスです。リッチ エディット コントロールは、作成者インデックスごとに異なるテキストの色を使用します。このメンバーを使用するには、dwMask メンバーに CFM_REVAUTHOR フラグを設定します。
bUnderlineColorBYTE1+83+83

下線の色:

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

共用体: _Anonymous_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
dwReservedDWORD4+0+0予約済みです。値は 0 でなければなりません。
dwCookieDWORD4+0+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 版を自動的に選択するエイリアスとして CHARFORMAT2 を定義しています。このエンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイル エラーや実行時エラーの原因になることがあります。詳細については、「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;

// CHARFORMAT2A  (x64 84 / x86 84 バイト)
typedef struct CHARFORMAT2A {
    CHARFORMATA Base;
    WORD wWeight;
    SHORT sSpacing;
    COLORREF crBackColor;
    DWORD lcid;
    _Anonymous_e__Union Anonymous;
    SHORT sStyle;
    WORD wKerning;
    BYTE bUnderlineType;
    BYTE bAnimation;
    BYTE bRevAuthor;
    BYTE bUnderlineColor;
} CHARFORMAT2A;
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;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CHARFORMAT2A
{
    public CHARFORMATA Base;
    public ushort wWeight;
    public short sSpacing;
    public uint crBackColor;
    public uint lcid;
    public _Anonymous_e__Union Anonymous;
    public short sStyle;
    public ushort wKerning;
    public byte bUnderlineType;
    public byte bAnimation;
    public byte bRevAuthor;
    public byte bUnderlineColor;
}
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

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CHARFORMAT2A
    Public Base As CHARFORMATA
    Public wWeight As UShort
    Public sSpacing As Short
    Public crBackColor As UInteger
    Public lcid As UInteger
    Public Anonymous As _Anonymous_e__Union
    Public sStyle As Short
    Public wKerning As UShort
    Public bUnderlineType As Byte
    Public bAnimation As Byte
    Public bRevAuthor As Byte
    Public bUnderlineColor As Byte
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),
    ]

class CHARFORMAT2A(ctypes.Structure):
    _fields_ = [
        ("Base", CHARFORMATA),
        ("wWeight", ctypes.c_ushort),
        ("sSpacing", ctypes.c_short),
        ("crBackColor", wintypes.DWORD),
        ("lcid", wintypes.DWORD),
        ("Anonymous", _Anonymous_e__Union),
        ("sStyle", ctypes.c_short),
        ("wKerning", ctypes.c_ushort),
        ("bUnderlineType", ctypes.c_ubyte),
        ("bAnimation", ctypes.c_ubyte),
        ("bRevAuthor", ctypes.c_ubyte),
        ("bUnderlineColor", ctypes.c_ubyte),
    ]
#[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],
}

#[repr(C)]
pub struct CHARFORMAT2A {
    pub Base: CHARFORMATA,
    pub wWeight: u16,
    pub sSpacing: i16,
    pub crBackColor: u32,
    pub lcid: u32,
    pub Anonymous: _Anonymous_e__Union,
    pub sStyle: i16,
    pub wKerning: u16,
    pub bUnderlineType: u8,
    pub bAnimation: u8,
    pub bRevAuthor: u8,
    pub bUnderlineColor: u8,
}
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 CHARFORMAT2A struct {
	Base CHARFORMATA
	wWeight uint16
	sSpacing int16
	crBackColor uint32
	lcid uint32
	Anonymous _Anonymous_e__Union
	sStyle int16
	wKerning uint16
	bUnderlineType byte
	bAnimation byte
	bRevAuthor byte
	bUnderlineColor byte
}
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;

  CHARFORMAT2A = record
    Base: CHARFORMATA;
    wWeight: Word;
    sSpacing: Smallint;
    crBackColor: DWORD;
    lcid: DWORD;
    Anonymous: _Anonymous_e__Union;
    sStyle: Smallint;
    wKerning: Word;
    bUnderlineType: Byte;
    bAnimation: Byte;
    bRevAuthor: Byte;
    bUnderlineColor: Byte;
  end;
const CHARFORMATA = extern struct {
    cbSize: u32,
    dwMask: u32,
    dwEffects: u32,
    yHeight: i32,
    yOffset: i32,
    crTextColor: u32,
    bCharSet: u8,
    bPitchAndFamily: u8,
    szFaceName: [32]i8,
};

const CHARFORMAT2A = extern struct {
    Base: CHARFORMATA,
    wWeight: u16,
    sSpacing: i16,
    crBackColor: u32,
    lcid: u32,
    Anonymous: _Anonymous_e__Union,
    sStyle: i16,
    wKerning: u16,
    bUnderlineType: u8,
    bAnimation: u8,
    bRevAuthor: u8,
    bUnderlineColor: u8,
};
type
  CHARFORMATA {.bycopy.} = object
    cbSize: uint32
    dwMask: uint32
    dwEffects: uint32
    yHeight: int32
    yOffset: int32
    crTextColor: uint32
    bCharSet: uint8
    bPitchAndFamily: uint8
    szFaceName: array[32, int8]

  CHARFORMAT2A {.bycopy.} = object
    Base: CHARFORMATA
    wWeight: uint16
    sSpacing: int16
    crBackColor: uint32
    lcid: uint32
    Anonymous: _Anonymous_e__Union
    sStyle: int16
    wKerning: uint16
    bUnderlineType: uint8
    bAnimation: uint8
    bRevAuthor: uint8
    bUnderlineColor: uint8
struct CHARFORMATA
{
    uint cbSize;
    uint dwMask;
    uint dwEffects;
    int yHeight;
    int yOffset;
    uint crTextColor;
    ubyte bCharSet;
    ubyte bPitchAndFamily;
    byte[32] szFaceName;
}

struct CHARFORMAT2A
{
    CHARFORMATA Base;
    ushort wWeight;
    short sSpacing;
    uint crBackColor;
    uint lcid;
    _Anonymous_e__Union Anonymous;
    short sStyle;
    ushort wKerning;
    ubyte bUnderlineType;
    ubyte bAnimation;
    ubyte bRevAuthor;
    ubyte bUnderlineColor;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CHARFORMAT2A サイズ: 84 バイト(x64)
dim st, 21    ; 4byte整数×21(構造体サイズ 84 / 4 切り上げ)
; Base : CHARFORMATA (+0, 60byte)  varptr(st)+0 を基点に操作(60byte:入れ子/配列)
; wWeight : WORD (+60, 2byte)  wpoke st,60,値  /  値 = wpeek(st,60)
; sSpacing : SHORT (+62, 2byte)  wpoke st,62,値  /  値 = wpeek(st,62)
; crBackColor : COLORREF (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; lcid : DWORD (+68, 4byte)  st.17 = 値  /  値 = st.17   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+72, 4byte)  varptr(st)+72 を基点に操作(4byte:入れ子/配列)
; sStyle : SHORT (+76, 2byte)  wpoke st,76,値  /  値 = wpeek(st,76)
; wKerning : WORD (+78, 2byte)  wpoke st,78,値  /  値 = wpeek(st,78)
; bUnderlineType : BYTE (+80, 1byte)  poke st,80,値  /  値 = peek(st,80)
; bAnimation : BYTE (+81, 1byte)  poke st,81,値  /  値 = peek(st,81)
; bRevAuthor : BYTE (+82, 1byte)  poke st,82,値  /  値 = peek(st,82)
; bUnderlineColor : BYTE (+83, 1byte)  poke st,83,値  /  値 = peek(st,83)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#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

#defstruct global CHARFORMAT2A
    #field CHARFORMATA Base
    #field short wWeight
    #field short sSpacing
    #field int crBackColor
    #field int lcid
    #field byte Anonymous 4
    #field short sStyle
    #field short wKerning
    #field byte bUnderlineType
    #field byte bAnimation
    #field byte bRevAuthor
    #field byte bUnderlineColor
#endstruct

stdim st, CHARFORMAT2A        ; NSTRUCT 変数を確保
st->wWeight = 100
mes "wWeight=" + st->wWeight
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。