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

PARAFORMAT

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 156 バイト / x86: 156 バイト

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

フィールド

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

有効な情報を含むメンバー、または設定する属性を指定します。このパラメーターには、何も指定しないか、次の値の組み合わせを指定できます。PFM_STARTINDENT と PFM_OFFSETINDENT の両方を指定した場合は、PFM_STARTINDENT が優先されます。

値 意味
PFM_ALIGNMENT
 wAlignment メンバーが有効です。
PFM_NUMBERING
 wNumbering メンバーが有効です。
PFM_OFFSET
 dxOffset メンバーが有効です。
PFM_OFFSETINDENT
 dxStartIndent メンバーが有効で、相対値を指定します。
PFM_RIGHTINDENT
 dxRightIndent メンバーが有効です。
PFM_RTLPARA
 Rich Edit 2.0: wEffects メンバーが有効です
PFM_STARTINDENT
 dxStartIndent メンバーが有効です。
PFM_TABSTOPS
 cTabStobs メンバーと rgxTabStops メンバーが有効です。
wNumberingPARAFORMAT_NUMBERING2+8+8箇条書きのオプションを指定する値です。このメンバーには 0 または PFN_BULLET を指定できます。
Anonymous_Anonymous_e__Union2+10+10wReserved等を含む無名共用体。予約領域として扱われる。
dxStartIndentINT4+12+12段落の 1 行目のインデント (twip 単位)。段落書式を設定する際に PFM_OFFSETINDENT を指定した場合、このメンバーは相対値として扱われ、影響を受ける各段落の開始インデントに加算されます。
dxRightIndentINT4+16+16右マージンを基準とした右インデントのサイズ (twip 単位)。
dxOffsetINT4+20+20開始インデントを基準とした、段落の 2 行目以降のインデント (twip 単位)。このメンバーが負の値の場合は 1 行目が字下げされ、正の値の場合は 1 行目が突き出し (ぶら下げ) になります。
wAlignmentPARAFORMAT_ALIGNMENT2+24+24

段落の配置を指定する値です。このメンバーには、次のいずれかの値を指定できます。

値 意味
PFA_CENTER
 段落を中央揃えにします。
PFA_LEFT
 段落を左マージンに揃えます。
PFA_RIGHT
 段落を右マージンに揃えます。
cTabCountSHORT2+26+26タブ ストップの数。
rgxTabsDWORD128+28+28

絶対的なタブ ストップ位置の配列です。配列の各要素は、1 つのタブ ストップに関する情報を指定します。下位 24 ビットは絶対オフセット (twip 単位) を指定します。このメンバーを使用するには、dwMask メンバーに PFM_TABSTOPS フラグを設定します。

Rich Edit 2.0: TOM インターフェイスとの互換性のため、上位 8 ビットを使用して各タブ ストップに関する追加情報を格納できます。

ビット 24 - 27 には、タブの配置を示す次のいずれかの値を指定できます。これらのビットは、Microsoft Rich Edit 3.0 より前のバージョンではリッチ エディット コントロールの表示に影響しません。

値 意味
0
 通常のタブ
1
 中央揃えタブ
2
 右揃えタブ
3
 小数点タブ
4
 ワード バー タブ (縦棒)

ビット 28 - 31 には、タブ リーダーの種類を示す次のいずれかの値を指定できます。これらのビットはリッチ エディット コントロールの表示に影響しません。

値 意味
0
 リーダーなし
1
 点線のリーダー
2
 破線のリーダー
3
 下線のリーダー
4
 太線のリーダー
5
 二重線のリーダー

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

フィールド型サイズx64x86説明
wReservedWORD2+0+0

Rich Edit 1.0:: このメンバーの名前は wReserved です。予約済みです。値は 0 でなければなりません。

Rich Edit 2.0: このメンバーの名前は wEffects です。段落の効果を指定するビット フラグです。TOM インターフェイスとの互換性のためにのみ用意されており、リッチ エディット コントロールは値を保持しますが、テキストの表示には使用しません。このパラメーターには、次のいずれかの値を指定できます。

値 意味
0
 左から右への読み取り順序でテキストを表示します。これが既定値です。
PFE_RLTPARA
 右から左への読み取り順序でテキストを表示します。
wEffectsWORD2+0+0

公式ドキュメント

リッチ エディット コントロールの段落書式属性に関する情報を格納します。この構造体は EM_GETPARAFORMAT メッセージおよび EM_SETPARAFORMAT メッセージで使用します。

Microsoft Rich Edit 2.0 では、PARAFORMAT2 構造体は PARAFORMAT 構造体を拡張した Microsoft Rich Edit 2.0 の構造体です。Microsoft Rich Edit 2.0 では、EM_GETPARAFORMAT と EM_SETPARAFORMAT のどちらでも、いずれの構造体も使用できます。

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

各言語での定義

#include <windows.h>

// PARAFORMAT  (x64 156 / x86 156 バイト)
typedef struct PARAFORMAT {
    DWORD cbSize;
    PARAFORMAT_MASK dwMask;
    PARAFORMAT_NUMBERING wNumbering;
    _Anonymous_e__Union Anonymous;
    INT dxStartIndent;
    INT dxRightIndent;
    INT dxOffset;
    PARAFORMAT_ALIGNMENT wAlignment;
    SHORT cTabCount;
    DWORD rgxTabs[32];
} PARAFORMAT;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct PARAFORMAT
{
    public uint cbSize;
    public uint dwMask;
    public ushort wNumbering;
    public _Anonymous_e__Union Anonymous;
    public int dxStartIndent;
    public int dxRightIndent;
    public int dxOffset;
    public ushort wAlignment;
    public short cTabCount;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 32)] public uint[] rgxTabs;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure PARAFORMAT
    Public cbSize As UInteger
    Public dwMask As UInteger
    Public wNumbering As UShort
    Public Anonymous As _Anonymous_e__Union
    Public dxStartIndent As Integer
    Public dxRightIndent As Integer
    Public dxOffset As Integer
    Public wAlignment As UShort
    Public cTabCount As Short
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=32)> Public rgxTabs() As UInteger
End Structure
import ctypes
from ctypes import wintypes

class PARAFORMAT(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("dwMask", wintypes.DWORD),
        ("wNumbering", ctypes.c_ushort),
        ("Anonymous", _Anonymous_e__Union),
        ("dxStartIndent", ctypes.c_int),
        ("dxRightIndent", ctypes.c_int),
        ("dxOffset", ctypes.c_int),
        ("wAlignment", ctypes.c_ushort),
        ("cTabCount", ctypes.c_short),
        ("rgxTabs", wintypes.DWORD * 32),
    ]
#[repr(C)]
pub struct PARAFORMAT {
    pub cbSize: u32,
    pub dwMask: u32,
    pub wNumbering: u16,
    pub Anonymous: _Anonymous_e__Union,
    pub dxStartIndent: i32,
    pub dxRightIndent: i32,
    pub dxOffset: i32,
    pub wAlignment: u16,
    pub cTabCount: i16,
    pub rgxTabs: [u32; 32],
}
import "golang.org/x/sys/windows"

type PARAFORMAT struct {
	cbSize uint32
	dwMask uint32
	wNumbering uint16
	Anonymous _Anonymous_e__Union
	dxStartIndent int32
	dxRightIndent int32
	dxOffset int32
	wAlignment uint16
	cTabCount int16
	rgxTabs [32]uint32
}
type
  PARAFORMAT = record
    cbSize: DWORD;
    dwMask: DWORD;
    wNumbering: Word;
    Anonymous: _Anonymous_e__Union;
    dxStartIndent: Integer;
    dxRightIndent: Integer;
    dxOffset: Integer;
    wAlignment: Word;
    cTabCount: Smallint;
    rgxTabs: array[0..31] of DWORD;
  end;
const PARAFORMAT = extern struct {
    cbSize: u32,
    dwMask: u32,
    wNumbering: u16,
    Anonymous: _Anonymous_e__Union,
    dxStartIndent: i32,
    dxRightIndent: i32,
    dxOffset: i32,
    wAlignment: u16,
    cTabCount: i16,
    rgxTabs: [32]u32,
};
type
  PARAFORMAT {.bycopy.} = object
    cbSize: uint32
    dwMask: uint32
    wNumbering: uint16
    Anonymous: _Anonymous_e__Union
    dxStartIndent: int32
    dxRightIndent: int32
    dxOffset: int32
    wAlignment: uint16
    cTabCount: int16
    rgxTabs: array[32, uint32]
struct PARAFORMAT
{
    uint cbSize;
    uint dwMask;
    ushort wNumbering;
    _Anonymous_e__Union Anonymous;
    int dxStartIndent;
    int dxRightIndent;
    int dxOffset;
    ushort wAlignment;
    short cTabCount;
    uint[32] rgxTabs;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PARAFORMAT サイズ: 156 バイト(x64)
dim st, 39    ; 4byte整数×39(構造体サイズ 156 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : PARAFORMAT_MASK (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; wNumbering : PARAFORMAT_NUMBERING (+8, 2byte)  wpoke st,8,値  /  値 = wpeek(st,8)
; Anonymous : _Anonymous_e__Union (+10, 2byte)  varptr(st)+10 を基点に操作(2byte:入れ子/配列)
; dxStartIndent : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dxRightIndent : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dxOffset : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; wAlignment : PARAFORMAT_ALIGNMENT (+24, 2byte)  wpoke st,24,値  /  値 = wpeek(st,24)
; cTabCount : SHORT (+26, 2byte)  wpoke st,26,値  /  値 = wpeek(st,26)
; rgxTabs : DWORD (+28, 128byte)  varptr(st)+28 を基点に操作(128byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PARAFORMAT
    #field int cbSize
    #field int dwMask
    #field short wNumbering
    #field byte Anonymous 2
    #field int dxStartIndent
    #field int dxRightIndent
    #field int dxOffset
    #field short wAlignment
    #field short cTabCount
    #field int rgxTabs 32
#endstruct

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