Win32 API 日本語リファレンス
ホームGraphics.Gdi › SetTextAlign

SetTextAlign

関数
テキスト出力時の文字位置揃え方法を設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

DWORD SetTextAlign(
    HDC hdc,
    TEXT_ALIGN_OPTIONS align
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
alignTEXT_ALIGN_OPTIONSin

テキストの配置を、次の一覧の値のマスクで指定します。水平方向および垂直方向の配置に影響する値の中からは、1 つのフラグのみを選択できます。さらに、現在位置を変更する 2 つのフラグのうち、どちらか一方のみを選択できます。

Value Meaning
TA_BASELINE
基準点はテキストのベースライン上に置かれます。
TA_BOTTOM
基準点は外接矩形の下端に置かれます。
TA_TOP
基準点は外接矩形の上端に置かれます。
TA_CENTER
基準点は外接矩形の中央に水平方向で揃えられます。
TA_LEFT
基準点は外接矩形の左端に置かれます。
TA_RIGHT
基準点は外接矩形の右端に置かれます。
TA_NOUPDATECP
各テキスト出力呼び出しの後に現在位置は更新されません。基準点はテキスト出力関数に渡されます。
TA_RTLREADING
Windows の中東言語版: テキストは、既定の左から右への順序ではなく、右から左への読み順で配置されます。これはデバイスコンテキストに選択されているフォントがヘブライ語またはアラビア語の場合にのみ適用されます。
TA_UPDATECP
各テキスト出力呼び出しの後に現在位置が更新されます。現在位置が基準点として使用されます。

漢字のように現在のフォントが縦書きの既定ベースラインを持つ場合は、TA_BASELINE および TA_CENTER の代わりに次の値を使用する必要があります。

Value Meaning
VTA_BASELINE
基準点はテキストのベースライン上に置かれます。
VTA_CENTER
基準点は外接矩形の中央に垂直方向で揃えられます。

既定値は TA_LEFTTA_TOP、および TA_NOUPDATECP です。

戻り値の型: DWORD

公式ドキュメント

SetTextAlign 関数は、指定されたデバイスコンテキストのテキスト配置フラグを設定します。

戻り値

関数が成功した場合、戻り値は以前のテキスト配置設定です。

関数が失敗した場合、戻り値は GDI_ERROR です。

解説(Remarks)

TextOut および ExtTextOut 関数は、ディスプレイやその他のデバイス上にテキスト文字列を配置するためにテキスト配置フラグを使用します。これらのフラグは、基準点とテキストを囲む矩形との関係を指定します。基準点は、現在位置か、テキスト出力関数に渡される点のいずれかです。

テキストを囲む矩形は、テキスト文字列内の文字セルによって形成されます。

左揃えのテキストを得る最良の方法は、次のいずれかを使用することです。


SetTextAlign (hdc, GetTextAlign(hdc) & (~TA_CENTER))

または


SetTextAlign (hdc,TA_LEFT | <other flags>)

この目的には SetTextAlign (hdc, TA_LEFT) も使用できますが、これは垂直方向または右から左への設定をすべて失います。

ScriptStringOut を使用しているときは、選択されたテキストが正しく描画されないため、TA_UPDATECP を指定して SetTextAlign を使用しないでください。このフラグを使用する必要がある場合は、必要に応じて解除および再設定することで問題を回避できます。

例については、Setting the Text Alignment を参照してください。

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

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

DWORD SetTextAlign(
    HDC hdc,
    TEXT_ALIGN_OPTIONS align
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint SetTextAlign(
    IntPtr hdc,   // HDC
    uint align   // TEXT_ALIGN_OPTIONS
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetTextAlign(
    hdc As IntPtr,   ' HDC
    align As UInteger   ' TEXT_ALIGN_OPTIONS
) As UInteger
End Function
' hdc : HDC
' align : TEXT_ALIGN_OPTIONS
Declare PtrSafe Function SetTextAlign Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal align As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetTextAlign = ctypes.windll.gdi32.SetTextAlign
SetTextAlign.restype = wintypes.DWORD
SetTextAlign.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # align : TEXT_ALIGN_OPTIONS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetTextAlign = Fiddle::Function.new(
  lib['SetTextAlign'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # align : TEXT_ALIGN_OPTIONS
  ],
  -Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn SetTextAlign(
        hdc: *mut core::ffi::c_void,  // HDC
        align: u32  // TEXT_ALIGN_OPTIONS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern uint SetTextAlign(IntPtr hdc, uint align);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetTextAlign' -Namespace Win32 -PassThru
# $api::SetTextAlign(hdc, align)
#uselib "GDI32.dll"
#func global SetTextAlign "SetTextAlign" sptr, sptr
; SetTextAlign hdc, align   ; 戻り値は stat
; hdc : HDC -> "sptr"
; align : TEXT_ALIGN_OPTIONS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global SetTextAlign "SetTextAlign" sptr, int
; res = SetTextAlign(hdc, align)
; hdc : HDC -> "sptr"
; align : TEXT_ALIGN_OPTIONS -> "int"
; DWORD SetTextAlign(HDC hdc, TEXT_ALIGN_OPTIONS align)
#uselib "GDI32.dll"
#cfunc global SetTextAlign "SetTextAlign" intptr, int
; res = SetTextAlign(hdc, align)
; hdc : HDC -> "intptr"
; align : TEXT_ALIGN_OPTIONS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetTextAlign = gdi32.NewProc("SetTextAlign")
)

// hdc (HDC), align (TEXT_ALIGN_OPTIONS)
r1, _, err := procSetTextAlign.Call(
	uintptr(hdc),
	uintptr(align),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SetTextAlign(
  hdc: THandle;   // HDC
  align: DWORD   // TEXT_ALIGN_OPTIONS
): DWORD; stdcall;
  external 'GDI32.dll' name 'SetTextAlign';
result := DllCall("GDI32\SetTextAlign"
    , "Ptr", hdc   ; HDC
    , "UInt", align   ; TEXT_ALIGN_OPTIONS
    , "UInt")   ; return: DWORD
●SetTextAlign(hdc, align) = DLL("GDI32.dll", "dword SetTextAlign(void*, dword)")
# 呼び出し: SetTextAlign(hdc, align)
# hdc : HDC -> "void*"
# align : TEXT_ALIGN_OPTIONS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn SetTextAlign(
    hdc: ?*anyopaque, // HDC
    align: u32 // TEXT_ALIGN_OPTIONS
) callconv(std.os.windows.WINAPI) u32;
proc SetTextAlign(
    hdc: pointer,  # HDC
    align: uint32  # TEXT_ALIGN_OPTIONS
): uint32 {.importc: "SetTextAlign", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
uint SetTextAlign(
    void* hdc,   // HDC
    uint align   // TEXT_ALIGN_OPTIONS
);
ccall((:SetTextAlign, "GDI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32),
      hdc, align)
# hdc : HDC -> Ptr{Cvoid}
# align : TEXT_ALIGN_OPTIONS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetTextAlign(
    void* hdc,
    uint32_t align);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.SetTextAlign(hdc, align)
-- hdc : HDC
-- align : TEXT_ALIGN_OPTIONS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const SetTextAlign = lib.func('__stdcall', 'SetTextAlign', 'uint32_t', ['void *', 'uint32_t']);
// SetTextAlign(hdc, align)
// hdc : HDC -> 'void *'
// align : TEXT_ALIGN_OPTIONS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  SetTextAlign: { parameters: ["pointer", "u32"], result: "u32" },
});
// lib.symbols.SetTextAlign(hdc, align)
// hdc : HDC -> "pointer"
// align : TEXT_ALIGN_OPTIONS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetTextAlign(
    void* hdc,
    uint32_t align);
C, "GDI32.dll");
// $ffi->SetTextAlign(hdc, align);
// hdc : HDC
// align : TEXT_ALIGN_OPTIONS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    int SetTextAlign(
        Pointer hdc,   // HDC
        int align   // TEXT_ALIGN_OPTIONS
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun SetTextAlign = SetTextAlign(
    hdc : Void*,   # HDC
    align : UInt32   # TEXT_ALIGN_OPTIONS
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetTextAlignNative = Uint32 Function(Pointer<Void>, Uint32);
typedef SetTextAlignDart = int Function(Pointer<Void>, int);
final SetTextAlign = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<SetTextAlignNative, SetTextAlignDart>('SetTextAlign');
// hdc : HDC -> Pointer<Void>
// align : TEXT_ALIGN_OPTIONS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetTextAlign(
  hdc: THandle;   // HDC
  align: DWORD   // TEXT_ALIGN_OPTIONS
): DWORD; stdcall;
  external 'GDI32.dll' name 'SetTextAlign';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetTextAlign"
  c_SetTextAlign :: Ptr () -> Word32 -> IO Word32
-- hdc : HDC -> Ptr ()
-- align : TEXT_ALIGN_OPTIONS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let settextalign =
  foreign "SetTextAlign"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* hdc : HDC -> (ptr void) *)
(* align : TEXT_ALIGN_OPTIONS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("SetTextAlign" set-text-align :convention :stdcall) :uint32
  (hdc :pointer)   ; HDC
  (align :uint32))   ; TEXT_ALIGN_OPTIONS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetTextAlign = Win32::API::More->new('GDI32',
    'DWORD SetTextAlign(HANDLE hdc, DWORD align)');
# my $ret = $SetTextAlign->Call($hdc, $align);
# hdc : HDC -> HANDLE
# align : TEXT_ALIGN_OPTIONS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型