SSSetEnhancedSheetTabColors Function
Applies To
fpSpread DLL control
Description
Sets the colors for the sheet tabs.
Syntax
BOOL SSSetEnhancedSheetTabColors(HWND hWnd, COLORREF clrNormalUpperStartColor, COLORREF clrNormalUpperEndColor, COLORREF clrNormalLowerStartColor, COLORREF clrNormalLowerEndColor, COLORREF clrHoverUpperStartColor, COLORREF clrHoverUpperEndColor, COLORREF clrHoverLowerStartColor, COLORREF clrHoverLowerEndColor, COLORREF clrTabOuterBorderColor, COLORREF clrTabInnerBorderColor, COLORREF clrButtonUpperNormalStartColor, COLORREF clrButtonUpperNormalEndColor, COLORREF clrButtonLowerNormalStartColor, COLORREF clrButtonLowerNormalEndColor, COLORREF clrButtonUpperHoverStartColor, COLORREF clrButtonUpperHoverEndColor, COLORREF clrButtonLowerHoverStartColor, COLORREF clrButtonLowerHoverEnd, COLORREF clrButtonUpperPushedStartColor, COLORREF clrButtonUpperPushedEndColor, COLORREF clrButtonLowerPushedStartColor, COLORREF clrButtonLowerPushedEndColor, COLORREF clrArrowColor, COLORREF clrBackColorStartColor, COLORREF clrBackColorEndColor, COLORREF clrSplitBoxStartColor, COLORREF clrSplitBoxEndColor, COLORREF clrForeColor, COLORREF clrActiveForeColor);
BOOL TSpread::SetEnhancedSheetTabColors(COLORREF clrNormalUpperStartColor, COLORREF clrNormalUpperEndColor, COLORREF clrNormalLowerStartColor, COLORREF clrNormalLowerEndColor, COLORREF clrHoverUpperStartColor, COLORREF clrHoverUpperEndColor, COLORREF clrHoverLowerStartColor, COLORREF clrHoverLowerEndColor, COLORREF clrTabOuterBorderColor, COLORREF clrTabInnerBorderColor, COLORREF clrButtonUpperNormalStartColor, COLORREF clrButtonUpperNormalEndColor, COLORREF clrButtonLowerNormalStartColor, COLORREF clrButtonLowerNormalEndColor, COLORREF clrButtonUpperHoverStartColor, COLORREF clrButtonUpperHoverEndColor, COLORREF clrButtonLowerHoverStartColor, COLORREF clrButtonLowerHoverEnd, COLORREF clrButtonUpperPushedStartColor, COLORREF clrButtonUpperPushedEndColor, COLORREF clrButtonLowerPushedStartColor, COLORREF clrButtonLowerPushedEndColor, COLORREF clrArrowColor, COLORREF clrBackColorStartColor, COLORREF clrBackColorEndColor, COLORREF clrSplitBoxStartColor, COLORREF clrSplitBoxEndColor, COLORREF clrForeColor, COLORREF clrActiveForeColor);
Parameters
The following parameters are available:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| clrNormalUpperStartColor | Beginning gradient color of the top half of the sheet tab |
| clrNormalUpperEndColor | Ending gradient color of the top half of the sheet tab |
| clrNormalLowerStartColor | Beginning gradient color of the lower half of the sheet tab |
| clrNormalLowerEndColor, | Ending gradient color of the lower half of the sheet tab |
| clrHoverUpperStartColor | Beginning gradient color of the top half of the sheet tab when the mouse is over the tab |
| clrHoverUpperEndColor | Ending gradient color of the top half of the sheet tab when the mouse is over the tab |
| clrHoverLowerStartColor | Beginning gradient color of the lower half of the sheet tab when the mouse is over the tab |
| clrHoverLowerEndColor | Ending gradient color of the lower half of the sheet tab when the mouse is over the tab |
| clrTabOuterBorderColor | Outer border color around the sheet tab |
| clrTabInnerBorderColor | Inner border color around the sheet tab |
| clrButtonUpperNormalStartColor | Beginning gradient color of the top half of the tab strip buttons |
| clrButtonUpperNormalEndColor | Ending gradient color of the top half of the tab strip buttons |
| clrButtonLowerNormalStartColor | Beginning gradient color of the lower half of the tab strip buttons |
| clrButtonLowerNormalEndColor | Ending gradient color of the lower half of the tab strip buttons |
| clrButtonUpperHoverStartColor | Beginning gradient color of the top half of the tab strip buttons when the mouse is over the button |
| clrButtonUpperHoverEndColor | Ending gradient color of the top half of the tab strip buttons when the mouse is over the button |
| clrButtonLowerHoverStartColor | Beginning gradient color of the lower half of the tab strip buttons when the mouse is over the button |
| clrButtonLowerHoverEnd | Ending gradient color of the lower half of the tab strip buttons when the mouse is over the button |
| clrButtonUpperPushedStartColor | Beginning gradient color of the top half of the tab strip buttons when the button is pressed |
| clrButtonUpperPushedEndColor | Ending gradient color of the top half of the tab strip buttons when the button is pressed |
| clrButtonLowerPushedStartColor | Beginning gradient color of the lower half of the tab strip buttons when the button is pressed |
| clrButtonLowerPushedEndColor | Ending gradient color of the lower half of the tab strip buttons when the button is pressed |
| clrArrowColor | Color of the next, previous, start, and end arrows in the tab strip |
| clrBackColorStartColor | Beginning gradient color of the sheet tab area (behind and to the right of the last tab name) |
| clrBackColorEndColor | Ending gradient color of the sheet tab area (behind and to the right of the last tab name) |
| clrSplitBoxStartColor | Beginning gradient color for the split box |
| clrSplitBoxEndColor | Ending gradient color for the split box |
| clrForeColor | Color of the sheet name text in the sheet tab |
| clrActiveForeColor | Color of the sheet name text for the active sheet tab |
Remarks
The hover color is the color under the mouse pointer. The arrow color is the color of the scroll bar arrow. The upper color is the upper half of the scroll bar and the lower color is the lower half of the scroll bar.
The upper color is the top half of the sheet tab icons. The lower color is the lower half of the sheet tab icons. Start refers to the beginning color in a gradient and end refers to the lower or ending color in the gradient. The start/beginning gradient applies from the top of the button/icon to the middle and the end/lower gradient applies from the middle to the bottom of the button/icon.
The tab strip buttons are the next, previous, end, and start buttons that let you change the active sheet.
The back color is the area to the right of the last sheet tab icon (gray area) and around the sheet tab icon.
Return Value
TRUE if the function completes successfully; FALSE otherwise.
See Also
SSSetAppearanceStyle, SSSetSheet, SSSetEnhancedCornerColors functions
ActiveX Correspondence
SetEnhancedSheetTabColors method