diff --git a/docs/xml/lcl/grids.xml b/docs/xml/lcl/grids.xml index 9af1541655..24fb56e1bb 100644 --- a/docs/xml/lcl/grids.xml +++ b/docs/xml/lcl/grids.xml @@ -15969,23 +15969,39 @@ Gets and displays the cell hint(s) for the current cell in the grid.

-ShowCellHintWindow is a procedure used to gets the value(s) and -display cell hint(s) for the cell located at the screen position in -APoint. Values in the Options and the -CellHintPriority properties determine the text available for use -as cell hints. +ShowCellHintWindow is a procedure used to get and display cell +hint(s) for the cell located at the position in APoint. APoint +contains client-relative coordinates for the mouse pointer used to locate the +cell for the hint. The values in APoint are translated to screen coordinates +(using ClientToScreen) when the cell hint is displayed by the application.

-GetCellHintText and GetTruncCellHintText are called to -get the corresponding hint text for the options and hint priority. -AddToHint is called to apply the derived text to the values -displayed in the control using its Hint property. -Application.ActivateHint is called to display the hint window. +Values in the Options and the CellHintPriority properties determine the text +available for use as cell hints. The grid can display three types of hint: the +default hint for the control (Hint property), individual cell hints (OnCellHint +event), and hints for truncated cells. TCellHintPriority determines how the +overall hint is combined when multiple hint texts are to be displayed.

-No actions are performed in the method when ShowHints contains -False, when the mouse pointer is not positioned over a grid cell, when -EditorMode is True, or at design-time. +GetCellHintText and GetTruncCellHintText are called to get the corresponding +hint text(s) for the options and hint priority. AddToHint is called to apply +the derived text to the values displayed in the control using its Hint +property. The Application.ActivateHint method is called to display the hint +window at the screen coordinates for the value in APoint. +

+

+No actions are performed in the method when: +

+ +

+ShowCellHintWindow is called from the MouseMove method, and occurs after a +prior hint displayed by the application has been cancelled and the cell for the +mouse pointer has has been updated in the grid cache.

@@ -15994,10 +16010,16 @@ No actions are performed in the method when ShowHints contains + + +TApplication.ActivateHint +TControl.ClientToScreen -Screen coordinates for the mouse pointer. + +Client coordinates for the mouse pointer. +