DrawThemeTextEx function (uxtheme.h)

Draws text using the color and font defined by the visual style. Extends DrawThemeText by allowing additional text format options.

Syntax

HRESULT DrawThemeTextEx(
  [in]      HTHEME        hTheme,
  [in]      HDC           hdc,
  [in]      int           iPartId,
  [in]      int           iStateId,
  [in]      LPCWSTR       pszText,
  [in]      int           cchText,
  [in]      DWORD         dwTextFlags,
  [in, out] LPRECT        pRect,
  [in]      const DTTOPTS *pOptions
);

Parameters

[in] hTheme

Type: HTHEME

Handle to a window's specified theme data. Use OpenThemeData to create an HTHEME.

[in] hdc

Type: HDC

HDC to use for drawing.

[in] iPartId

Type: int

The control part that has the desired text appearance. See Parts and States. If this value is 0, the text is drawn in the default font, or a font selected into the device context.

[in] iStateId

Type: int

The control state that has the desired text appearance. See Parts and States.

[in] pszText

Type: LPCWSTR

Pointer to a string that contains the text to draw.

[in] cchText

Type: int

Value of type int that contains the number of characters to draw. If the parameter is set to -1, all the characters in the string are drawn.

[in] dwTextFlags

Type: DWORD

DWORD that contains one or more values that specify the string's formatting. See Format Values for possible parameter values.

[in, out] pRect

Type: LPRECT

Pointer to a RECT structure that contains the rectangle, in logical coordinates, in which the text is to be drawn.

[in] pOptions

Type: const DTTOPTS*

A DTTOPTS structure that defines additional formatting options that will be applied to the text being drawn.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The function always uses the themed font for the specified part and state if one is defined. Otherwise it uses the font currently selected into the device context. To find out if a themed font is defined, you can call GetThemeFont or GetThemePropertyOrigin with TMT_FONT as the property identifier.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	uxtheme.h
Library	UxTheme.lib
DLL	UxTheme.dll