wpSetIconTextBackgroundColor
This method is specific to Version 4, or higher, of the OS/2 operating system.
This instance method sets the color to be used for the icon text background.
Syntax
wpSetIconTextBackgroundColor(somSelf, ulColor, fRefreshViews)
Parameters
- somSelf (WPFolder *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPFolder.
- ulColor (ULONG) - input
- The **RGB** color value or **USE_GLOBAL_COLOR**.
- The RGB value must be presented as a 6-digit hex value in the format **0xRRGGBB** where RR, GG, and BB are the red, green, and blue values ranging between 0x00 and 0xFF (0-255).
- fRefreshViews (BOOL) - input
- Refresh open views flag.
- **TRUE** Refreshes all open views.
- **FALSE** Does not refresh the open views.
Returns
- rc (none) - returns
- There is no return value for this method.
How to Override
This method is generally not overridden.
Usage
This method can be called at any time in order to set the text background color for the **Icon**, **Tree**, and **Details View** of a folder.
Example Code
#define INCL_WINWORKPLACE
#include <os2.h>
WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulColor; /* The RGB color value or USE_GLOBAL_COLOR. */
BOOL fRefreshViews; /* Refresh open views flag. */
wpSetIconTextBackgroundColor(somSelf, ulColor,
fRefreshViews);
/* Example code provided in the source: */
_wpSetIconTextBackgroundColor(somSelf,RGB_CYAN);