RealGrid2 API
Interface
MultiLineCellEditor

MultiLineCellEditor

Editor that can accept multi-line input

Inherits CellEditor.

[Superclass]

CellEditor

Signature:

export interface MultiLineCellEditor extends CellEditor

Extends: CellEditor

Example

//string type
column.editor = "multiline"
 
// object type
column.editor = { type: "multiline", maxLength: 50}

Properties

PropertyTypeDescription
altEnterNewLinebooleanSpecify key to force newline
heightnumberheight of editor
maxLengthnumberMaximum length of characters that can be entered
minHeightnumberMinimum height of editor.
minWidthnumberMinimum width of the editor.
type'multiline'Cell editor type: multiline
widthnumberWidth of the editor

Properties Desc

altEnterNewLine

Specify key to force newline

Type - boolean

Remarks:

If true, ctrl + enter is ignored and a forced line break is performed with alt + enter or shift + enter.

If false, force a line break with ctrl + enter.


height

height of editor

Type - number

Remarks:

If it is 0, the height is automatically adjusted according to the input content. In case of -1, it is fixed to the height of the cell. If it is 0 or higher, it is fixed to the entered height.


maxLength

Maximum length of characters that can be entered

Type - number

Remarks:

There is no limit when entering 0.


minHeight

Minimum height of editor.

Type - number


minWidth

Minimum width of editor.

Type - number


type

Cell editor type: Multiline

Type - 'multiline'


width

Width of editor

Type - number

Remarks:

If 0, automatically adjust the width to the entered content. If -1, fix it to the width of the cell. If 0 or more, fix it to the entered width.