ClipValue Property
Applies To
fpSpread control
Description
Sets or returns unformatted data into or from a column, a row, or a block of cells. This property is available at run time only.
Syntax
CString CSpreadSheet::GetClipValue( );
void CSpreadSheet::SetClipValue(LPCTSTR value);
[form.]fpSpread.ClipValue[ = text$]
Remarks
This setting is applied to the current sheet setting unless you first set the Sheet property to specify the sheet for which you are setting the property. Before providing or returning the data, you must specify the cells with which you want to work, as described in Using Column and Row Properties. You do not need to set the BlockMode property.
Data for each column is separated by a tab character (ASCII 9, or `\t' in C++); each row is separated by a carriage return/linefeed character (ASCII 13 and ASCII 10, or `\r' and `\n' in C++).
The following table explains the data format to use when setting data using the ClipValue property, and the format returned when returning data using the ClipValue property. Values in quotation marks (" ") are string values.
| Cell Type | Sample Data | Set or Return Data |
|---|---|---|
| Button | True (Two-state) | "1" |
| False (Two-state) | "0" | |
| Not set (Two-state; looks False) | "0" | |
| Check Box | True | "1" |
| False | "0" | |
| Grayed | "2" | |
| Not set; looks False | "0" | |
| Combo Box | Index number of selected item | |
| Currency | "$10,000.00" | "10000.00" |
| Date | "10/29/2001" | "10292001" When setting, provide date value as "MMDDYYYY". |
| Edit | Text string If the TypeEditMultiLine property is set to True, a linefeed character (ASCII 10 or `\n' in C++) can be used to force a line break when setting text. |
|
| Number | "10,000.00" | "10000" or "1E4" |
| Owner-Drawn | not applicable | |
| Percent | "15% | "0.15" |
| PIC | "22-45-76" | 224576 |
| Picture | not applicable | |
| Scientific | "2.22E+05" | "222222" |
| Static Text | Text string If the TypeTextWordWrap property is set to True, a linefeed character (ASCII 10 or `\n' in C++) can be used to force a line break when setting text. |
|
| Time | "11:25:03 pm" | "232503" When setting, provide time value as "HHMMSS" using 24-hour format. |
The ClipValue property can be used to set or return data in cells, as can the Clip, Text, and Value properties, and the GetFloat, GetInteger, GetText, SetFloat, SetInteger, and SetText methods. Use the ClipValue property to set or return unformatted data in blocks of cells. Number values that contain a decimal symbol must use a period regardless of the international settings. For more information about using these properties and methods, see Adding Data and Returning Data. For more information about formatted data, see Formatted and Unformatted Data.
Data Type
String
See Also
Clip, Sheet, Text, TypeEditMultiLine, TypeTextWordWrap, Value properties
GetFloat, GetInteger, GetText, SetFloat, SetInteger, SetText methods
DLL Correspondence
SSClipValueIn, SSClipValueOut functions