{/* Do not edit this file. It is automatically generated by API Documenter. */}


## BTDateCellEditor

Editor using BootStrap DatePicker

**Signature:**

```typescript
export interface BTDateCellEditor extends TextCellEditor
```
**Extends:** [TextCellEditor](/refs/Interface/TextCellEditor)

## Remarks

After bundling, you must apply the file as follows for it to work properly.

Inherits [TextCellEditor](/refs/Interface/TextCellEditor).

\[Superclass\]

[CellEditor](/refs/Interface/CellEditor) - [TextCellEditor](/refs/Interface/TextCellEditor)

## Example


```js
//string type
column.editor = "btdate"

//object type
column.editor = { type: "btdate", maxLength: 6, textReadOnly: true }
```

```html
<script type="text/javascript" src="/lib/bootstrap/bootstrap-datepicker.js"></script>
<script type="text/javascript" src="/lib/bootstrap/bootstrap-datepicker.ko.min.js"></script>
<link rel="stylesheet" type="text/css" href="/lib/css/bootstrap-datepicker.css">
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [btOptions](/refs/Interface/BTDateCellEditor#btoptions) | any | Options for BootStrap DatePicker |
| [commitOnSelect](/refs/Interface/BTDateCellEditor#commitonselect) | boolean | Whether to commit when selected |
| [dropDownPosition](/refs/Interface/BTDateCellEditor#dropdownposition) | [DropDownPosition](/refs/realgrid#dropdownposition) | Location of calendar selection box |
| [dropDownWhenClick](/refs/Interface/BTDateCellEditor#dropdownwhenclick) | boolean | Whether to expand the list when a cell is clicked |
| [dropDownWhenTyping](/refs/Interface/BTDateCellEditor#dropdownwhentyping) | boolean | Whether to display the list when typing |
| [editFormat](/refs/Interface/BTDateCellEditor#editformat) | string | **_(ALPHA)_** Edit Format |
| [maxDate](/refs/Interface/BTDateCellEditor#maxdate) | string \| Date | Maximum date that can be entered |
| [minDate](/refs/Interface/BTDateCellEditor#mindate) | string \| Date | Minimum date allowed for entry |
| [textReadOnly](/refs/Interface/BTDateCellEditor#textreadonly) | boolean | Whether to prohibit input using the keyboard |
| [type](/refs/Interface/BTDateCellEditor#type) | 'btdate' | Cell editor type: Bootstrap date editor |
| [viewGridInside](/refs/Interface/BTDateCellEditor#viewgridinside) | boolean | Whether to include it inside the grid DOM |

## Properties Desc

### btOptions

Options for BootStrap DatePicker

`Type` - any

**Remarks:**

[Reference](https://uxsolutions.github.io/bootstrap-datepicker/)

<hr/>

### commitOnSelect

Whether to commit when selected

`Type` - boolean

<hr/>

### dropDownPosition

Location of calendar selection box

`Type` - [DropDownPosition](/refs/realgrid#dropdownposition)

<hr/>

### dropDownWhenClick

Whether to expand the list when a cell is clicked

`Type` - boolean

<hr/>

### dropDownWhenTyping

Whether to display the list when typing.

`Type` - boolean

**Remarks:**

If `false`{/* */} is set, the list will only be displayed when the button is clicked.

<hr/>

### editFormat

Edit Format

`Type` - string

<hr/>

### maxDate

Maximum date that can be entered

`Type` - string \| Date

**Remarks:**

If a date later than maxDate is entered with the keyboard, it is changed to maxDate.

<hr/>

### minDate

Minimum date allowed for entry

`Type` - string \| Date

**Remarks:**

If a date earlier than minDate is entered with the keyboard, it is changed to minDate.

<hr/>

### textReadOnly

Whether input using the keyboard is prohibited

`Type` - boolean

<hr/>

### type

Cell editor type: Bootstrap date editor

`Type` - 'btdate'

<hr/>

### viewGridInside

Whether to include it inside the grid DOM

`Type` - boolean

<hr/>