GetCalTextOverride, ScriptGetCalTextOverride Methods
Applies To
fpSpread control
Description
Returns the text for the pop-up calendar provided for date cells in a specific fpSpread control.
Syntax
void CSpreadSheet::GetCalTextOverride(BSTR* ShortDays, short* LenShortDays, BSTR* LongDays, short* LenLongDays, BSTR* ShortMonths, short* LenShortMonths, BSTR* LongMonths, short* LenLongMonths, BSTR* OkText, short* LenOkText, BSTR* CancelText, short* LenCancelText);
fpSpread.GetCalTextOverride(ShortDays As String, LenShortDays As Integer, LongDays As String, LenLongDays As Integer, ShortMonths As String, LenShortMonths As Integer, LongMonths As String, LenLongMonths As Integer, OkText As String, LenOkText As Integer, CancelText As String, LenCancelText As Integer)
Note: The ScriptGetCalTextOverride 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 |
---|---|
ShortDays | Short day names |
LenShortDays | Returns the length of the buffer that contains the short day names |
LongDays | Long day names |
LenLongDays | Returns the length of the buffer that contains the long day names |
ShortMonths | Short month names |
LenShortMonths | Returns the length of the buffer that contains the short month names |
LongMonths | Long month names |
LenLongMonths | Returns the length of the buffer that contains the long month names |
OkText | Text for the OK button |
LenOkText | Returns the length of the buffer that contains the OK button text |
CancelText | Text for the Cancel button |
LenCancelText | Returns the length of the buffer that contains the Cancel button text |
Remarks
The SetCalTextOverride method sets the text for the pop-up calendar provided for a date cell in a specific Spread control. Use the GetCalTextOverride or ScriptGetCalTextOverride method if you want to return the text for the pop-up calendars for a specific Spread control.
This method is applied to the entire workbook, including all sheets in the control.
The GetCalTextOverride or ScriptGetCalTextOverride method returns the text for the day names and month names as strings separated by the tab character (\t).
To display the pop-up calendar, double-click the date cell or press the F4 key (unless the you have changed the action of the F4 key using the SetActionKey method).
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 ScriptGetCalTextOverride method. ScriptGetCalTextOverride method parameters that are not passed "ByVal" are declared as variants. |
Return Type
None
See Also
Customizing the Pop-up Calendar
GetActionKey, SetActionKey, SetCalText, SetCalTextOverride methods
ScriptEnhanced property
DLL Correspondence
SSGetCalTextOverride function