Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

GetThemeBackgroundContentRect function

Retrieves the size of the content area for the background defined by the visual style.

Syntax


HRESULT GetThemeBackgroundContentRect(
  _In_   HTHEME hTheme,
  _In_   HDC hdc,
  _In_   int iPartId,
  _In_   int iStateId,
  _In_   LPCRECT pBoundingRect,
  _Out_  LPRECT pContentRect
);

Parameters

hTheme [in]

Type: HTHEME

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

hdc [in]

Type: HDC

HDC to use when drawing. This parameter may be set to NULL.

iPartId [in]

Type: int

Value of type int that specifies the part that contains the content area. See Parts and States.

iStateId [in]

Type: int

Value of type int that specifies the state of the part that contains the content area. See Parts and States.

pBoundingRect [in]

Type: LPCRECT

Pointer to a RECT structure that contains the total background rectangle, in logical coordinates. This is the area inside the borders or margins.

pContentRect [out]

Type: LPRECT

Pointer to a RECT structure that receives the content area background rectangle, in logical coordinates. This rectangle is calculated to fit the content area.

Return value

Type: HRESULT

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

Remarks

A visual style can define a content area within each background image. This is the area where content such as text and icons can be placed without overwriting background borders.

Examples

When applying a theme to an entire client area of a window, you can call GetClientRect to retrieve this area in a RECT, which can be passed via pointer as the pContentRect parameter to GetThemeBackgroundContentRect as in the following example.


DWORD resultFlags = GetThemeAppProperties();
bool ctrlsAreThemed = ((resultFlags & STAP_ALLOW_CONTROLS) != 0);


Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Uxtheme.h

Library

UxTheme.lib

DLL

UxTheme.dll

See also

Reference
Property Identifiers
GetThemeBackgroundExtent

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.