SetEnhancedSheetTabColors Method
Applies To
fpSpread control
Description
Sets the colors for the sheet tabs.
Syntax
BOOL CSpreadSheet::SetEnhancedSheetTabColors(long clrNormalUpperStartColor, long clrNormalUpperEndColor, long clrNormalLowerStartColor, long clrNormalLowerEndColor,long clrHoverUpperStartColor, long clrHoverUpperEndColor,long clrHoverLowerStartColor, long clrHoverLowerEndColor,long clrTabOuterBorderColor, long clrTabInnerBorderColor,long clrButtonUpperNormalStartColor,long clrButtonUpperNormalEndColor,long clrButtonLowerNormalStartColor,long clrButtonLowerNormalEndColor,long clrButtonUpperHoverStartColor,long clrButtonUpperHoverEndColor,long clrButtonLowerHoverStartColor,long clrButtonLowerHoverEndColor,long clrButtonUpperPushedStartColor,long clrButtonUpperPushedEndColor,long clrButtonLowerPushedStartColor,long clrButtonLowerPushedEndColor,long clrArrowColor,long clrBackColorStartColor,long clrBackColorEndColor,long clrSplitBoxStartColor,long clrSplitBoxEndColor,long clrSheetTabForeColor,long clrSheetTabActiveForeColor);
fpSpread.SetEnhancedSheetTabColors(ByVal clrNormalUpperStartColor As Long, ByVal clrNormalUpperEndColor As Long, ByVal clrNormalLowerStartColor As Long, ByVal clrNormalLowerEndColor As Long, ByVal clrHoverUpperStartColor As Long, ByVal clrHoverUpperEndColor As Long, ByVal clrHoverLowerStartColor As Long, ByVal clrHoverLowerEndColor As Long, ByVal clrTabOuterBorderColor As Long, ByVal clrTabInnerBorderColor As Long,ByVal clrButtonUpperNormalStartColor As Long,ByVal clrButtonUpperNormalEndColor As Long,ByVal clrButtonLowerNormalStartColor As Long,ByVal clrButtonLowerNormalEndColor As Long,ByVal clrButtonUpperHoverStartColor As Long,ByVal clrButtonUpperHoverEndColor As Long,ByVal clrButtonLowerHoverStartColor As Long,ByVal clrButtonLowerHoverEndColor As Long,ByVal clrButtonUpperPushedStartColor As Long,ByVal clrButtonUpperPushedEndColor As Long,ByVal clrButtonLowerPushedStartColor As Long,ByVal clrButtonLowerPushedEndColor As Long,ByVal clrArrowColor As Long,ByVal clrBackColorStartColor As Long,ByVal clrBackColorEndColor As Long,ByVal clrSplitBoxStartColor As Long,ByVal clrSplitBoxEndColor As Long,ByVal clrSheetTabForeColor As Long,ByVal clrSheetTabActiveForeColor As Long)As Boolean
Parameters
The following parameters are available:
| Parameter | Description |
|---|---|
| clrNormalUpperStartColor | Beginning gradient color of the top half of the sheet tab (default value is RGB(216,231,250) |
| clrNormalUpperEndColor | Ending gradient color of the top half of the sheet tab (default value is RGB(213,229,249) |
| clrNormalLowerStartColor | Beginning gradient color of the lower half of the sheet tab (default value is RGB(182,210,245) |
| clrNormalLowerEndColor | Ending gradient color of the lower half of the sheet tab (default value is RGB(217,231,249) |
| clrHoverUpperStartColor | Beginning gradient color of the top half of the sheet tab when the mouse is over the tab (default value is RGB(255,255,255) |
| clrHoverUpperEndColor | Ending gradient color of the top half of the sheet tab when the mouse is over the tab (default value is RGB(255,255,255) |
| clrHoverLowerStartColor | Beginning gradient color of the lower half of the sheet tab when the mouse is over the tab (default value is RGB(255,255,255) |
| clrHoverLowerEndColor | Ending gradient color of the lower half of the sheet tab when the mouse is over the tab (default value is RGB(183,210,244) |
| clrTabOuterBorderColor | Outer border color around the sheet tab (default value is RGB(146,165,199) |
| clrTabInnerBorderColor | Inner border color around the sheet tab (default value is RGB(255,255,255) |
| clrButtonUpperNormalStartColor | Beginning gradient color of the top half of the tab strip buttons (default value is RGB(216,231,250) |
| clrButtonUpperNormalEndColor | Ending gradient color of the top half of the tab strip buttons (default value is RGB(213,229,249) |
| clrButtonLowerNormalStartColor | Beginning gradient color of the lower half of the tab strip buttons (default value is RGB(182,210,245) |
| clrButtonLowerNormalEndColor | Ending gradient color of the lower half of the tab strip buttons (default value is RGB(217,231,249) |
| clrButtonUpperHoverStartColor | Beginning gradient color of the top half of the tab strip buttons when the mouse is over the button (default value is RGB(234,241,249) |
| clrButtonUpperHoverEndColor | Ending gradient color of the top half of the tab strip buttons when the mouse is over the button (default value is RGB(216,228,244) |
| clrButtonLowerHoverStartColor | Beginning gradient color of the lower half of the tab strip buttons when the mouse is over the button (default value is RGB(219,230,245) |
| clrButtonLowerHoverEndColor | Ending gradient color of the lower half of the tab strip buttons when the mouse is over the button (default value is RGB(232,239,249) |
| clrButtonUpperPushedStartColor | Beginning gradient color of the top half of the tab strip buttons when the button is pressed (default value is RGB(199,217,243) |
| clrButtonUpperPushedEndColor | Ending gradient color of the top half of the tab strip buttons when the button is pressed (default value is RGB(195,214,242) |
| clrButtonLowerPushedStartColor | Beginning gradient color of the lower half of the tab strip buttons when the button is pressed (default value is RGB(146,182,232) |
| clrButtonLowerPushedEndColor | Ending gradient color of the lower half of the tab strip buttons when the button is pressed (default value is RGB(190,212,241) |
| clrArrowColor | Color of the next, previous, start, and end arrows in the tab strip (default value is RGB(106,90,205) |
| clrBackColorStartColor | Beginning gradient color of the sheet tab area (behind and to the right of the last tab name) (default value is RGB(127,161,209) |
| clrBackColorEndColor | Ending gradient color of the sheet tab area (behind and to the right of the last tab name) (default value is RGB(161,186,221) |
| clrSplitBoxStartColor | Beginning gradient color for the split box (default value is RGB(127,161,209) |
| clrSplitBoxEndColor | Ending gradient color for the split box (default value is RGB(161,186,221) |
| clrSheetTabForeColor | Color of the sheet name text in the sheet tab (default value is RGB(0,0,0) |
| clrSheetTabActiveForeColor | Color of the sheet name text for the active sheet tab (default value is RGB(0,0,0) |
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 BackColor is the area to the right of the last sheet tab icon (gray area) and around the sheet tab icon.
Return Type
True if successful; otherwise, False.
See Also
BackColor, ForeColor, Sheet properties
SetEnhancedCornerColors, SetEnhancedRowHeaderColors methods
DLL Correspondence
SSSetEnhancedSheetTabColors function