DrawThemeText

関数

テーマの書式に従ってテキストを描画する。

DLLUXTHEME.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT DrawThemeText(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchText,
    DRAW_TEXT_FORMAT dwTextFlags,
    DWORD dwTextFlags2,
    RECT* pRect
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウのテーマデータへのハンドル。HTHEME を作成するには OpenThemeData を使用します。
hdc	HDC	in	描画に使用する HDC。
iPartId	INT	in	目的のテキスト外観を持つコントロールパーツ。Parts and States を参照してください。この値が 0 の場合、テキストは既定のフォント、またはデバイスコンテキストに選択されているフォントで描画されます。
iStateId	INT	in	目的のテキスト外観を持つコントロール状態。Parts and States を参照してください。
pszText	LPCWSTR	in	描画するテキストを含む文字列へのポインター。
cchText	INT	in	描画する文字数を含む int 型の値。このパラメーターを -1 に設定すると、文字列内のすべての文字が描画されます。
dwTextFlags	DRAW_TEXT_FORMAT	in	文字列の書式を指定する 1 つ以上の値を含む DWORD。指定可能なパラメーター値については Format Values を参照してください。注意 DrawThemeText は DT_CALCRECT をサポートしていません。ただし、DrawThemeTextEx は DT_CALCRECT をサポートしています。
dwTextFlags2	DWORD	in	使用されません。ゼロに設定します。
pRect	RECT*	in	テキストを描画する矩形(論理座標)を含む RECT 構造体へのポインター。正しい座標を取得するには、GetThemeTextExtent の pExtentRect を使用することをお勧めします。

戻り値の型: HRESULT

公式ドキュメント

ビジュアルスタイルで定義された色とフォントを使用してテキストを描画します。

戻り値

型: HRESULT

この関数が成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数は、指定したパーツと状態にテーマフォントが定義されている場合、常にそのテーマフォントを使用します。定義されていない場合は、現在デバイスコンテキストに選択されているフォントを使用します。テーマフォントが定義されているかどうかを確認するには、プロパティ識別子として TMT_FONT を指定して GetThemeFont または GetThemePropertyOrigin を呼び出します。

例

DrawThemeText は Win32 の DrawText 関数と同様のパラメーターを使用しますが、いくつかの違いがあります。最も顕著な違いの 1 つは、ワイド文字列をサポートしている点です。したがって、次の例のように、ワイドでない文字列はワイド文字列に変換する必要があります。

セキュリティに関する警告: MultiByteToWideChar を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。ワイド文字バッファーを作成する際は、バイト単位ではなくワイド文字単位での文字列サイズを収容できる十分な大きさであることを確認してください。

INT cchText = GetWindowTextLength(_hwnd);
if (cchText > 0)
{
    TCHAR *pszText = new TCHAR[cchText+1];
    if (pszText)
    {
        if (GetWindowText(_hwnd, pszText, cchText+1))
        {
            int widelen = MultiByteToWideChar(CP_ACP, 0, reinterpret_cast<LPCSTR>(pszText), 
                    cchText+1, NULL, 0);
            WCHAR *pszWideText = new WCHAR[widelen+1];
            MultiByteToWideChar(CP_ACP, 0, reinterpret_cast<LPCSTR>(pszText), cchText, 
                    pszWideText, widelen);

            SetBkMode(hdcPaint, TRANSPARENT);
            DrawThemeText(_hTheme,
                    hdcPaint,
                    BP_PUSHBUTTON,
                    _iStateId,
                    pszWideText,
                    cchText,
                    DT_CENTER | DT_VCENTER | DT_SINGLELINE,
                    NULL,
                    &rcContent);

            delete [] pszWideText;
        }

        delete [] pszText;
    }
}

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

各言語での呼び出し定義

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

HRESULT DrawThemeText(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchText,
    DRAW_TEXT_FORMAT dwTextFlags,
    DWORD dwTextFlags2,
    RECT* pRect
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int DrawThemeText(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC
    int iPartId,   // INT
    int iStateId,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string pszText,   // LPCWSTR
    int cchText,   // INT
    uint dwTextFlags,   // DRAW_TEXT_FORMAT
    uint dwTextFlags2,   // DWORD
    IntPtr pRect   // RECT*
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function DrawThemeText(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> pszText As String,   ' LPCWSTR
    cchText As Integer,   ' INT
    dwTextFlags As UInteger,   ' DRAW_TEXT_FORMAT
    dwTextFlags2 As UInteger,   ' DWORD
    pRect As IntPtr   ' RECT*
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC
' iPartId : INT
' iStateId : INT
' pszText : LPCWSTR
' cchText : INT
' dwTextFlags : DRAW_TEXT_FORMAT
' dwTextFlags2 : DWORD
' pRect : RECT*
Declare PtrSafe Function DrawThemeText Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal pszText As LongPtr, _
    ByVal cchText As Long, _
    ByVal dwTextFlags As Long, _
    ByVal dwTextFlags2 As Long, _
    ByVal pRect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawThemeText = ctypes.windll.uxtheme.DrawThemeText
DrawThemeText.restype = ctypes.c_int
DrawThemeText.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    wintypes.LPCWSTR,  # pszText : LPCWSTR
    ctypes.c_int,  # cchText : INT
    wintypes.DWORD,  # dwTextFlags : DRAW_TEXT_FORMAT
    wintypes.DWORD,  # dwTextFlags2 : DWORD
    ctypes.c_void_p,  # pRect : RECT*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
DrawThemeText = Fiddle::Function.new(
  lib['DrawThemeText'],
  [
    Fiddle::TYPE_INTPTR_T,  # hTheme : HTHEME
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # iPartId : INT
    Fiddle::TYPE_INT,  # iStateId : INT
    Fiddle::TYPE_VOIDP,  # pszText : LPCWSTR
    Fiddle::TYPE_INT,  # cchText : INT
    -Fiddle::TYPE_INT,  # dwTextFlags : DRAW_TEXT_FORMAT
    -Fiddle::TYPE_INT,  # dwTextFlags2 : DWORD
    Fiddle::TYPE_VOIDP,  # pRect : RECT*
  ],
  Fiddle::TYPE_INT)

#[link(name = "uxtheme")]
extern "system" {
    fn DrawThemeText(
        hTheme: isize,  // HTHEME
        hdc: *mut core::ffi::c_void,  // HDC
        iPartId: i32,  // INT
        iStateId: i32,  // INT
        pszText: *const u16,  // LPCWSTR
        cchText: i32,  // INT
        dwTextFlags: u32,  // DRAW_TEXT_FORMAT
        dwTextFlags2: u32,  // DWORD
        pRect: *mut RECT  // RECT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int DrawThemeText(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, [MarshalAs(UnmanagedType.LPWStr)] string pszText, int cchText, uint dwTextFlags, uint dwTextFlags2, IntPtr pRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_DrawThemeText' -Namespace Win32 -PassThru
# $api::DrawThemeText(hTheme, hdc, iPartId, iStateId, pszText, cchText, dwTextFlags, dwTextFlags2, pRect)

#uselib "UXTHEME.dll"
#func global DrawThemeText "DrawThemeText" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DrawThemeText hTheme, hdc, iPartId, iStateId, pszText, cchText, dwTextFlags, dwTextFlags2, varptr(pRect)   ; 戻り値は stat
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "sptr"
; iStateId : INT -> "sptr"
; pszText : LPCWSTR -> "sptr"
; cchText : INT -> "sptr"
; dwTextFlags : DRAW_TEXT_FORMAT -> "sptr"
; dwTextFlags2 : DWORD -> "sptr"
; pRect : RECT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "UXTHEME.dll"
#cfunc global DrawThemeText "DrawThemeText" sptr, sptr, int, int, wstr, int, int, int, var
; res = DrawThemeText(hTheme, hdc, iPartId, iStateId, pszText, cchText, dwTextFlags, dwTextFlags2, pRect)
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pszText : LPCWSTR -> "wstr"
; cchText : INT -> "int"
; dwTextFlags : DRAW_TEXT_FORMAT -> "int"
; dwTextFlags2 : DWORD -> "int"
; pRect : RECT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "UXTHEME.dll"
#cfunc global DrawThemeText "DrawThemeText" sptr, sptr, int, int, wstr, int, int, int, sptr
; res = DrawThemeText(hTheme, hdc, iPartId, iStateId, pszText, cchText, dwTextFlags, dwTextFlags2, varptr(pRect))
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pszText : LPCWSTR -> "wstr"
; cchText : INT -> "int"
; dwTextFlags : DRAW_TEXT_FORMAT -> "int"
; dwTextFlags2 : DWORD -> "int"
; pRect : RECT* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。