Editing getSysColor - FilterMeisterWiki

When saving, enter the following:

##   ##   ZZZZZZZ  ######   TTTTT   __   __
##  ##     ZZ   Z  # ## #   TT  TT  \ \ / /
## ##      ZZ        ##     TT  TT   \ V / 
####       ZZZZZ     ##     TTTTT    /   \ 
## ##      ZZ        ##     TT      / /^\ \
##  ##     ZZ   Z    ##     TT      \/   \/
##   ##   ZZZZZZZ   ####    TT

Visit Preferences to set your user name

= getSysColor =

== Syntax ==
{{int getSysColor(int colorIndex)}}

== Arguments ==
:'''colorIndex'''
::The color display element value to retrieve

== Display Elements ==
These values can also be found in the official [https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getsyscolor MSDN GetSysColor] docs.
|| COLOR_3DDKSHADOW || Dark shadow for three-dimensional display elements. ||
|| COLOR_3DFACE || Face color for three-dimensional display elements and for dialog box backgrounds. ||
|| COLOR_3DHIGHLIGHT || Highlight color for three-dimensional display elements (for edges facing the light source.) ||
|| COLOR_3DHILIGHT || Highlight color for three-dimensional display elements (for edges facing the light source.) ||
|| COLOR_3DLIGHT || Light color for three-dimensional display elements (for edges facing the light source.) ||
|| COLOR_3DSHADOW || Shadow color for three-dimensional display elements (for edges facing away from the light source). ||
|| COLOR_ACTIVEBORDER ||  Active window border. ||
|| COLOR_ACTIVECAPTION || Active window title bar. ||
|| COLOR_APPWORKSPACE || Background color of multiple document interface (MDI) applications. ||
|| COLOR_BACKGROUND || Desktop. ||
|| COLOR_BTNFACE || Face color for three-dimensional display elements and for dialog box backgrounds. ||
|| COLOR_BTNHIGHLIGHT || Highlight color for three-dimensional display elements (for edges facing the light source.) ||
|| COLOR_BTNHILIGHT || Highlight color for three-dimensional display elements (for edges facing the light source.) ||
|| COLOR_BTNSHADOW || Shadow color for three-dimensional display elements (for edges facing away from the light source). ||
|| COLOR_BTNTEXT || Text on push buttons. ||
|| COLOR_CAPTIONTEXT || Text in caption, size box, and scroll bar arrow box. ||
|| COLOR_DESKTOP || Desktop. ||
|| COLOR_GRADIENTACTIVECAPTION || Right side color in the color gradient of an active window's title bar. ||
|| COLOR_GRADIENTINACTIVECAPTION || Right side color in the color gradient of an inactive window's title bar. ||
|| COLOR_GRAYTEXT || Grayed (disabled) text. ||
|| COLOR_HIGHLIGHT || Items selected in a control. ||
|| COLOR_HIGHLIGHTTEXT || Text of items selected in a control. ||
|| COLOR_HOTLIGHT || Color for a hyperlink or hot-tracked item.  ||
|| COLOR_INACTIVEBORDER || Inactive window border. ||
|| COLOR_INACTIVECAPTION || Inactive window caption. ||
|| COLOR_INACTIVECAPTIONTEXT || Color of text in an inactive caption. ||
|| COLOR_INFOBK || Background color for tooltip controls. ||
|| COLOR_INFOTEXT || Text color for tooltip controls. ||
|| COLOR_MENU || Menu background. ||
|| COLOR_MENUHILIGHT || The color used to highlight menu items when the menu appears as a flat menu. ''(Not supported on Windows 2000.)'' ||
|| COLOR_MENUBAR || The background color for the menu bar when menus appear as flat menus. ''(Not supported on Windows 2000.)'' ||
|| COLOR_MENUTEXT || Text in menus. ||
|| COLOR_SCROLLBAR || Scroll bar gray area. ||
|| COLOR_WINDOW || Window background. ||
|| COLOR_WINDOWFRAME || Window frame. ||
|| COLOR_WINDOWTEXT || Text in windows. ||

== Return ==
Returns the color element as an integer.  Use the ((Rval)), ((GVal)) and ((BVal)) functions to retrieve the color component values.

== Description ==
Retrieves the current color of the specified display element.

== Example ==
<code>
%ffp

OnFilterStart: {
  // Make background light blue
  int color = getSysColor(COLOR_HIGHLIGHT);
  setDialogColor(color);
  return false;
}
</code>

== See Also ==
((setCtlColor)), ((setDialogColor))

Summary of change:
Add document to category: