Clip Property
Applies To
fpSpread control
Description
Sets or returns formatted data into or from a column, a row, or a block of cells. This property is available at run time only.
Syntax
CString CSpreadSheet::GetClip( );
void CSpreadSheet::SetClip(LPCTSTR value);
[form.]fpSpread.Clip[ = 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 Clip property, and the format returned when returning data using the Clip 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) | Empty string | |
| Check Box | True | "1" |
| False | "0" | |
| Grayed | "2" | |
| Not set; looks False | Empty string | |
| Combo Box | Text string of selected item | |
| Currency | "$10,000.00" | "$10,000.00" |
| Date | "10/29/2001" | "10/29/2001" When setting, provide in format that matches the setting of the TypeDateFormat property. Use a separator where separators are displayed in the format. |
| Edit | Text 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" | "$10,000.00" or "1E4" |
| Owner-Drawn | not applicable | |
| Percent | "15%" | "15%" |
| PIC | "22-45-76" | "22-45-76" or "22 45 76" where space is used instead of typing the placeholder character for setting data |
| Picture | not applicable | |
| Scientific | "2.22E+05" | "2.22E+05" |
| 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" | "11:25:03 pm" When setting and using an a.m./p.m. indicator, include a space between the time value and the indicator, for example, "10:00:00 p.m." |
The Clip property can be used to set or return data in cells, as can the ClipValue, Text, and Value properties, and the GetFloat, GetInteger, GetText, SetFloat, SetInteger, and SetText methods. Use the Clip property to set or return formatted data in blocks of cells. 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
ClipValue, Sheet, Text, TypeDateFormat, TypeEditMultiLine, TypeTextWordWrap, Value properties
GetFloat, GetInteger, GetText, SetFloat, SetInteger, SetText methods