DrawThemeTextEx

関数

オプション指定でテーマ書式のテキストを描画する拡張版。

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

シグネチャ

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

HRESULT DrawThemeTextEx(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchText,
    DRAW_TEXT_FORMAT dwTextFlags,
    RECT* pRect,
    const DTTOPTS* pOptions   // optional
);

パラメーター

名前	型	方向	説明
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 を参照してください。
pRect	RECT*	inout	テキストを描画する論理座標での矩形を含む RECT 構造体へのポインターです。
pOptions	DTTOPTS*	inoptional	描画されるテキストに適用される追加の書式オプションを定義する DTTOPTS 構造体です。

戻り値の型: HRESULT

公式ドキュメント

ビジュアルスタイルで定義された色とフォントを使用してテキストを描画します。DrawThemeText を拡張し、追加のテキスト書式オプションを指定できるようにします。

戻り値

型: HRESULT

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

HRESULT DrawThemeTextEx(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchText,
    DRAW_TEXT_FORMAT dwTextFlags,
    RECT* pRect,
    const DTTOPTS* pOptions   // optional
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int DrawThemeTextEx(
    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
    IntPtr pRect,   // RECT* in/out
    IntPtr pOptions   // DTTOPTS* optional
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function DrawThemeTextEx(
    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
    pRect As IntPtr,   ' RECT* in/out
    pOptions As IntPtr   ' DTTOPTS* optional
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC
' iPartId : INT
' iStateId : INT
' pszText : LPCWSTR
' cchText : INT
' dwTextFlags : DRAW_TEXT_FORMAT
' pRect : RECT* in/out
' pOptions : DTTOPTS* optional
Declare PtrSafe Function DrawThemeTextEx 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 pRect As LongPtr, _
    ByVal pOptions As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawThemeTextEx = ctypes.windll.uxtheme.DrawThemeTextEx
DrawThemeTextEx.restype = ctypes.c_int
DrawThemeTextEx.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
    ctypes.c_void_p,  # pRect : RECT* in/out
    ctypes.c_void_p,  # pOptions : DTTOPTS* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
DrawThemeTextEx = Fiddle::Function.new(
  lib['DrawThemeTextEx'],
  [
    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_VOIDP,  # pRect : RECT* in/out
    Fiddle::TYPE_VOIDP,  # pOptions : DTTOPTS* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "uxtheme")]
extern "system" {
    fn DrawThemeTextEx(
        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
        pRect: *mut RECT,  // RECT* in/out
        pOptions: *const DTTOPTS  // DTTOPTS* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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