FlatSB_SetScrollProp function (commctrl.h)

Article
2022-01-20

Sets the properties for a flat scroll bar.

Syntax

BOOL FlatSB_SetScrollProp(
  HWND    unnamedParam1,
  UINT    index,
  INT_PTR newValue,
  BOOL    unnamedParam4
);

Parameters

unnamedParam1

Type: HWND

A handle to the window that contains the flat scroll bar. This window handle must have been passed previously in a call to InitializeFlatSB.

index

Type: UINT

Determines what newValue represents and which property is being set. This parameter can be one of the following values:

Value	Meaning
WSB_PROP_CXHSCROLL	newValue is an INT_PTR value that represents the width, in pixels, of the direction buttons in a horizontal scroll bar.
WSB_PROP_CXHTHUMB	newValue is an INT_PTR value that represents the width, in pixels, of the thumb in a horizontal scroll bar.
WSB_PROP_CXVSCROLL	newValue is an INT_PTR value that represents the width, in pixels, of the vertical scroll bar.
WSB_PROP_CYHSCROLL	newValue is an INT_PTR value that represents the height, in pixels, of the horizontal scroll bar.
WSB_PROP_CYVSCROLL	newValue is an INT_PTR value that represents the height, in pixels, of the direction buttons in a vertical scroll bar.
WSB_PROP_CYVTHUMB	newValue is an INT_PTR value that represents the height, in pixels, of the thumb in a vertical scroll bar.
WSB_PROP_HBKGCOLOR	newValue is a COLORREF value that represents the background color in a horizontal scroll bar.
WSB_PROP_HSTYLE	newValue is one of the following values that changes the visual effects for the horizontal scroll bar. FSB_ENCARTA_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar will be displayed in 3-D. FSB_FLAT_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar will be displayed in inverted colors. FSB_REGULAR_MODE A normal, nonflat scroll bar is displayed. No special visual effects will be applied.
WSB_PROP_PALETTE	newValue is an HPALETTE value that represents the new palette that the scroll bar should use when drawing.
WSB_PROP_VBKGCOLOR	newValue is a COLORREF value that represents the background color in a vertical scroll bar.
WSB_PROP_VSTYLE	newValue is one of the following values that changes the visual effects for the vertical scroll bar: FSB_ENCARTA_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar will be displayed in 3-D. FSB_FLAT_MODE A standard flat scroll bar is displayed. When the mouse moves over a direction button or the thumb, that portion of the scroll bar will be displayed in inverted colors. FSB_REGULAR_MODE A normal, nonflat scroll bar is displayed. No special visual effects will be applied.

newValue

Type: INT_PTR

A new value to set. This parameter depends on the flag passed in index.

unnamedParam4

Type: BOOL

Specifies whether the scroll bar should be redrawn immediately to reflect the change. If this parameter is TRUE, the scroll bar is redrawn; if it is FALSE, the scroll bar is not redrawn.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

Remarks

Note Flat scroll bar functions are implemented in Comctl32.dll versions 4.71 through 5.82. Comctl32.dll versions 6.00 and higher do not support flat scroll bars.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h
Library	Comctl32.lib
DLL	Comctl32.dll (version 4.71 or later)

Share via