Spread 8.0 Documentation
SSGetBorderEx Function
Support Options
DLL Reference > DLL Functions > SSGetBorderEx Function

Glossary Item Box

SSGetBorderEx Function


See Also

Applies To

fpSpread DLL control

Description

Returns the cell border settings for each side of the specified cell.

Syntax

C

BOOL SSGetBorderEx(HWND hWnd, SS_COORD Col, SS_COORD Row, LPWORD lpwStyleLeft, LPCOLORREF lpclrLeft, LPWORD lpwStyleTop, LPCOLORREF lpclrTop, LPWORD lpwStyleRight, LPCOLORREF lpclrRight, LPWORD lpwStyleBottom, LPCOLORREF lpclrBottom);

C++

BOOL TSpread::GetBorderEx(SS_COORD Col, SS_COORD Row, LPWORD lpwStyleLeft, LPCOLORREF lpclrLeft, LPWORD lpwStyleTop, LPCOLORREF lpclrTop, LPWORD lpwStyleRight, LPCOLORREF lpclrRight, LPWORD lpwStyleBottom, LPCOLORREF lpclrBottom);

Parameters

This function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpread control
Col Column number of the cell to return settings for
Row Row number of the cell to return settings for
lpwStyleLeft Border style setting for the left side of the cell
lpclrLeft Color setting for the left side of the cell
lpwStyleTop Border style setting for the top of the cell
lpclrTop Color setting for the top of the cell
lpwStyleRight Border style setting for the right side of the cell
lpclrRight Color setting for the right side of the cell
lpwStyleBottom Border style setting for the bottom of the cell
lpclrBottom Color setting for the bottom of the cell

The Style parameters can be one of the following values:

Value Constant Description
0 SS_BORDERSTYLE_NONE Default
1 SS_BORDERSTYLE_SOLID Solid
2 SS_BORDERSTYLE_DASH Dash
3 SS_BORDERSTYLE_DOT Dot
4 SS_BORDERSTYLE_DASH_DOT Dash Dot
5 SS_BORDERSTYLE_DASH_DOT_DOT Dash Dot Dot
6 SS_BORDERSTYLE_BLANK Blank
11 SS_BORDERSTYLE_FINE_SOLID Fine Solid
12 SS_BORDERSTYLE_FINE_DASH Fine Dash
13 SS_BORDERSTYLE_FINE_DOT Fine Dot
14 SS_BORDERSTYLE_FINE_DASH_DOT Fine Dash Dot
15 SS_BORDERSTYLE_FINE_DASH_DOT_DOT Fine Dash Dot Dot

Remarks

This function is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet for which you are calling this function.

Call the SSSetBorder or SSSetBorderRange function to set the borders for a cell or a range of cells.

Return Value

TRUE if the function completes successfully; FALSE otherwise.

See Also

SSGetBorder, SSSetBorder, SSSetBorderRange, SSSetSheet functions

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.