Spread Windows Forms 15.0
GrapeCity.Win.PluginInputMan Assembly / GrapeCity.Win.Spread.InputMan.CellType Namespace / DropDownEditor Class / ScrollToCaret Method


In This Topic
    ScrollToCaret Method (DropDownEditor)
    In This Topic
    Scrolls the contents of the control to the current caret position.
    Syntax
    'Declaration
     
    
    Public Sub ScrollToCaret() 
    'Usage
     
    
    Dim instance As DropDownEditor
     
    instance.ScrollToCaret()
    public void ScrollToCaret()
    Remarks
    This method enables you to scroll the contents of the control until the caret is within the visible region of the control. If the caret is positioned below the visible region of the control, the ScrollToCaret method will scroll the contents of the control until the caret is visible at the bottom of the control. If the caret is positioned above the visible region of the control, this method scrolls the contents of the control until the caret is visible at the top of the control. A similar policy exists for the horizontal direction and it moves the caret to 1/3 width from the left or right side. You can use this method in a multiline edit to ensure that the current text entry point is within the visible region of the control.
    Note: This method has no effect if the control does not have focus or if the caret is already positioned in the visible region of the control.
    See Also