GetTextTipAppearance, ScriptGetTextTipAppearance Methods
Applies To
fpSpread control
Description
Returns the appearance settings of text tips and cell notes.
Syntax
BOOL CSpreadSheet::GetTextTipAppearance(BSTR* FontName, short* FontSize, BOOL* FontBold, BOOL* FontItalic, long* BackColor, long* ForeColor);
fpSpread.GetTextTipAppearance(FontName As String, FontSize As Integer, FontBold As Boolean, FontItalic As Boolean, BackColor As Long, ForeColor As Long) As Boolean
Note: The ScriptGetTextTipAppearance 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 |
---|---|
TipFontName | Font name |
TipFontSize | Font size |
TipFontBold | Whether font is boldface |
TipFontItalic | Whether font is italic |
TipBackColor | Background color |
TipForeColor | Foreground (text) color |
Remarks
Use the TextTip property to specify whether and when text tips and cell notes are displayed and how they are positioned. Text tips are displayed for headers or cells in the control when the pointer is over a header or cell. Cell notes are displayed for cells or headers in the control when the pointer is over a cell note indicator, a red square in the upper right corner of the cell, as shown in the following figure.
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.
You can specify that the control delays displaying text tips by specifying the number of milliseconds to delay using the TextTipDelay property.
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 ScriptGetTextTipAppearance method. ScriptGetTextTipAppearance method parameters that are not passed "ByVal" are declared as variants. |
Return Type
True if successful; otherwise, False.
See Also
Specifying the Appearance of Text Tips
Providing Cell Notes
ScriptEnhanced, Sheet, TextTip, TextTipDelay properties
TextTipFetch event
SetTextTipAppearance method
DLL Correspondence
SSGetTextTip function