GetClientArea, ScriptGetClientArea Methods
Applies To
fpSpread control
Description
Returns the height and width of the client area in twips.
Syntax
C++
void CSpreadSheet::GetClientArea (long* Width, long* Height);
Visual Basic
fpSpread.GetClientArea(Width As Long, Height As Long)
Note: The ScriptGetClientArea method uses the same syntax except method parameters that are not passed "ByVal" are declared as variants. For more information on Script methods, see Scripting Environment Usage. |
Parameters
The following parameters are available:
Parameter | Description |
---|---|
Width | Width of client area |
Height | Height of client area |
Remarks
The client area is the area of the sheet minus the area of the scroll bars.
The returned height and width values are in twips.
This method is called for the current sheet setting unless you first set the Sheet property to specify the sheet with which you want to work.
Note: Call this method if you use the Spread control in a scripting environment (for example, Microsoft's Visual InterDev or Internet Explorer) or a non-scripting environment. However, if you want to use the Spread control in a scripting environment and you want to change any parameter that is not passed "ByVal", you must set the ScriptEnhanced property to True and call the ScriptGetClientArea method. ScriptGetClientArea method parameters that are not passed "ByVal" are declared as variants. |
Return Type
Returns the height and width of the client area in the Height and Width parameters.
See Also
ScriptEnhanced, Sheet properties
DLL Correspondence
SSGetClientRect function