Spread Windows Forms 13.0 Product Documentation
FarPoint.Win Assembly / FarPoint.Win.SuperEdit Namespace / AcceptsArrowKeys Enumeration


In This Topic
    AcceptsArrowKeys Enumeration
    In This Topic
    Specifies how the control processes the keyboard arrow keys in the text box.
    Syntax
    'Declaration
     
    Public Enum AcceptsArrowKeys 
       Inherits System.Enum
    'Usage
     
    Dim instance As AcceptsArrowKeys
    public enum AcceptsArrowKeys : System.Enum 
    Members
    MemberDescription
    AllArrowsProcesses all the keyboard arrow keys (like Arrows and CtrlArrows combined).
    AllArrowsIgnoringMultilineProcesses all the keyboard arrow keys regardless of the Multiline property setting.
    ArrowsProcesses the keyboard arrow keys but not with the Ctrl key.
    CtrlArrowsProcesses the keyboard arrow keys only when the Ctrl key is also pressed.
    NoneDoes not process any of the arrow keys.
    Remarks

    In the table below

    • in a single-byte character systems,
        • a "small text unit" is a "character"
        • a "large text unit" is a "word"
    • in double-byte character systems, both the small text unit and the large text unit are a double-byte character (glyph).

    Setting

    Description
      None With this setting the text box does not process any of the arrow keys, and any arrow key pressed is passed to the parent control.
      Arrows With this setting the text box processes the keyboard arrow keys as long as the Ctrl key is not pressed. The left and right arrow keys move the cursor one small text unit left or right. If the text is on multiple lines, up and down arrow keys move the cursor up or down one line at a time. The combination of Ctrl key and any arrow key is passed to the parent control. If the text is not multiple line, up and down arrow keys are passed to the parent control.
      CtrlArrows With this setting the text box processes the keyboard arrow keys only when the Ctrl key is also pressed. The Ctrl-left and Ctrl-right arrow keys move the cursor one small text unit left or right. Ctrl-up and Ctrl-down arrow keys do nothing. Arrow keys without the Ctrl key are passed to the parent control. If the text is not on multiple lines, then Ctrl-up and Ctrl-down are passed to the parent control.
      AllArrows

    With this setting the text box processes all the keyboard arrow keys. This is essentially both Arrows and CtrlArrows combined. Both up and down as well as Ctrl-up and Ctrl-down key combinations are allowed. 

    If text is on multiple lines:

    • Up and down arrow keys move the cursor one line at a time
    • Left and right arrow keys move the cursor one small text unit
    • Ctrl-up and Ctrl-down arrow keys do nothing
    • Ctrl-left and Ctrl-right arrow keys move the cursor by one large text unit

    If text is not on multiple lines, up, down, Ctrl-up and Ctrl-down are passed to the parent control.

    AllArrowsIgnoringMultiline     

    With this setting the text box the keyboard arrow keys similar to AllArrows with the added feature of allowing both up and down arrow keys and Ctrl-up and Ctrl-down arrow key combinations for both multiple lines and single lines.

    If the text is on multiple lines, it is the same as for AllArrows.

    If text is not on multiple lines,

    • Up and down arrow keys move left and right by one small text unit
    • Ctrl-up and Ctrl-down move the cursor left or right by one larger unit

    This is the most inclusive setting and allows any arrow key (or Ctrl and arrow key combination) regardless of whether there are multiple lines (and the Multiline property setting in some cell types). 

    Inheritance Hierarchy

    System.Object
       System.ValueType
          System.Enum
             FarPoint.Win.SuperEdit.AcceptsArrowKeys

    See Also