Custom Editors
Different editors can be used to edit cell values in grid columns. The default editor depends on the column configuration. The dependency is illustrated in the editorOptions object's description (this object is used to customize the default editor). In this demo, the SelectBox component is the Status column's default editor, and the editorOptions object is used to specify the component's itemTemplate.
If the default editor is unsuitable, replace it with a custom editor by specifying an editCellTemplate. In this template, configure the replacement editor's appearance and behavior. In this demo, the default editors in the Owner and Assignees columns are replaced with the DropDownBox and TagBox components.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<dx-data-grid
id="gridContainer"
[dataSource]="tasks"
[showBorders]="true"
(onRowInserted)="$event.component.navigateToRow($event.key)"
>
<dxo-paging [enabled]="true" [pageSize]="15"></dxo-paging>
<dxo-header-filter [visible]="true"></dxo-header-filter>
<dxo-search-panel [visible]="true"></dxo-search-panel>
<dxo-editing
mode="cell"
[allowUpdating]="true"
[allowAdding]="true">
</dxo-editing>
<dxi-column
dataField="Owner"
[width]="150"
[allowSorting]="false"
editCellTemplate="singleDropDownBoxEditor"
>
<dxo-lookup
[dataSource]="employees"
displayExpr="FullName"
valueExpr="ID">
</dxo-lookup>
<dxi-validation-rule type="required"></dxi-validation-rule>
</dxi-column>
<dxi-column
dataField="AssignedEmployee"
caption="Assignees"
[width]="200"
[allowSorting]="false"
editCellTemplate="tagBoxEditor"
[cellTemplate]="cellTemplate"
[calculateFilterExpression]="calculateFilterExpression">
<dxo-lookup
[dataSource]="employees"
valueExpr="ID"
displayExpr="FullName">
</dxo-lookup>
<dxi-validation-rule type="required"></dxi-validation-rule>
</dxi-column>
<dxi-column dataField="Subject">
<dxi-validation-rule type="required"></dxi-validation-rule>
</dxi-column>
<dxi-column
dataField="Status"
width="200"
[editorOptions]="editorOptions"
>
<dxo-lookup
[dataSource]="statuses"
displayExpr="name"
valueExpr="id">
</dxo-lookup>
<dxi-validation-rule type="required"></dxi-validation-rule>
</dxi-column>
<div *dxTemplate="let cellInfo of 'tagBoxEditor'">
<dx-tag-box
[dataSource]="employees"
[value]="cellInfo.value"
valueExpr="ID"
displayExpr="FullName"
[showSelectionControls]="true"
[maxDisplayedTags]="3"
[showMultiTagOnly]="false"
applyValueMode="useButtons"
[searchEnabled]="true"
(onValueChanged)="cellInfo.setValue($event.value)"
(onSelectionChanged)="cellInfo.component.updateDimensions()">
</dx-tag-box>
</div>
<div *dxTemplate="let cellInfo of 'singleDropDownBoxEditor'">
<dx-drop-down-box
[dropDownOptions]="dropDownOptions"
[dataSource]="employees"
[(value)]="cellInfo.value"
displayExpr="FullName"
valueExpr="ID"
contentTemplate="contentTemplate">
<div *dxTemplate="let e of 'contentTemplate'">
<dx-data-grid
[dataSource]="employees"
[remoteOperations]="true"
[height]="250"
[selectedRowKeys]="[cellInfo.value]"
[focusedRowEnabled]="true"
[focusedRowKey]="cellInfo.value"
[hoverStateEnabled]="true"
(onSelectionChanged)="onSelectionChanged($event.selectedRowKeys, cellInfo, e.component)"
>
<dxi-column dataField="FullName"></dxi-column>
<dxi-column dataField="Title"></dxi-column>
<dxi-column dataField="Department"></dxi-column>
<dxo-paging [enabled]="true" [pageSize]="10"></dxo-paging>
<dxo-scrolling mode="virtual"></dxo-scrolling>
<dxo-selection mode="single" ></dxo-selection>
</dx-data-grid>
</div>
</dx-drop-down-box>
</div>
<div *dxTemplate="let status of 'statusTemplate'">
<div *ngIf="status === null"; else elseBlock>
<span>(All)</span>
</div>
<div dx-template #elseBlock>
<img src="images/icons/status-{{status.id}}.svg" class="status-icon middle">
<span class="middle">{{status.name}}</span>
</div>
</div>
</dx-data-grid>
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { DxDataGridModule, DxListModule, DxDropDownBoxModule, DxTagBoxModule } from 'devextreme-angular';
import { Service, Status } from './app.service';
import { createStore } from "devextreme-aspnet-data-nojquery";
if(!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
selector: 'demo-app',
templateUrl: 'app/app.component.html',
styleUrls: ['app/app.component.css'],
providers: [Service]
})
export class AppComponent {
employees: object;
tasks: object;
statuses: Status[];
dropDownOptions: object;
editorOptions: object;
url: string;
constructor(service: Service) {
this.dropDownOptions = { width: 500 };
this.editorOptions = {
itemTemplate: "statusTemplate"
}
this.url = "https://js.devexpress.com/Demos/Mvc/api/CustomEditors";
this.statuses = service.getStatuses();
this.tasks = createStore({
key: "ID",
loadUrl: this.url + "/Tasks",
updateUrl: this.url + "/UpdateTask",
insertUrl: this.url + "/InsertTask",
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
});
this.employees = createStore({
key: "ID",
loadUrl: this.url + "/Employees",
onBeforeSend: function(method, ajaxOptions) {
ajaxOptions.xhrFields = { withCredentials: true };
}
});
}
onSelectionChanged(selectedRowKeys, cellInfo, dropDownBoxComponent) {
cellInfo.setValue(selectedRowKeys[0]);
if(selectedRowKeys.length > 0) {
dropDownBoxComponent.close();
}
}
calculateFilterExpression(filterValue, selectedFilterOperation, target) {
if(target === "search" && typeof(filterValue) === "string") {
return [(this as any).dataField, "contains", filterValue];
}
return function(data) {
return (data.AssignedEmployee || []).indexOf(filterValue) !== -1
}
}
cellTemplate(container, options) {
var noBreakSpace = "\u00A0",
text = (options.value || []).map(element => {
return options.column.lookup.calculateCellValue(element);
}).join(", ");
container.textContent = text || noBreakSpace;
container.title = text;
}
}
@NgModule({
imports: [
BrowserModule,
DxDataGridModule,
DxListModule,
DxDropDownBoxModule,
DxTagBoxModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
.status-icon {
height: 16px;
width: 16px;
display: inline-block;
margin-right: 8px;
}
.middle {
vertical-align: middle;
}
import { Injectable } from '@angular/core';
export class Status {
id: number;
name: string;
}
let statuses: Status[] = [{
"id": 1, "name": "Not Started"
}, {
"id": 2, "name": "In Progress"
}, {
"id": 3, "name": "Deferred"
}, {
"id": 4, "name": "Need Assistance"
}, {
"id": 5, "name": "Completed"
}
];
@Injectable()
export class Service {
getStatuses() {
return statuses;
}
}
// In real applications, you should not transpile code in the browser. You can see how to create your own application with Angular and DevExtreme here:
// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/
window.config = {
transpiler: 'ts',
typescriptOptions: {
module: "system",
emitDecoratorMetadata: true,
experimentalDecorators: true
},
meta: {
'typescript': {
"exports": "ts"
},
'devextreme-aspnet-data-nojquery': {
"esModule": true
},
'devextreme/localization.js': {
"esModule": true
}
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',
'typescript': 'npm:typescript@3.5.3/lib/typescript.js',
'@angular': 'npm:@angular',
'tslib': 'npm:tslib@2.2.0/tslib.js',
'rxjs': 'npm:rxjs@6.4.0',
'devextreme-aspnet-data-nojquery': 'npm:devextreme-aspnet-data-nojquery@2.8.4/index.js',
'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.27.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@21.1.3/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@21.1.3/bundles/dx.all.js',
'jszip': 'npm:jszip@3.6.0/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.0.0/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.1.15',
'devexpress-gantt': 'npm:devexpress-gantt@2.1.31',
'devextreme-angular': 'npm:devextreme-angular@21.1.3',
'@devextreme/vdom': 'npm:@devextreme/vdom@1.2.1',
'inferno': 'npm:inferno@7.4.8/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat@7.4.8/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.8/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom@1.0.7/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.8/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.8/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class@7.4.8/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras@7.4.8/dist/inferno-extras.min.js'
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts'
},
'devextreme': {
defaultExtension: 'js'
},
'@devextreme/vdom': {
defaultExtension: 'js'
},
'devextreme/events/utils': {
main: 'index'
},
'devextreme/events': {
main: 'index'
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js'
}
},
packageConfigPaths: [
"npm:@devextreme/*/package.json",
"npm:@angular/*/package.json",
"npm:@angular/common/*/package.json",
"npm:rxjs/package.json",
"npm:rxjs/operators/package.json",
"npm:devextreme-angular/*/package.json",
"npm:devextreme-angular/ui/*/package.json",
"npm:devextreme-angular/package.json",
"npm:devexpress-diagram/package.json",
"npm:devexpress-gantt/package.json",
]
};
System.config(window.config);
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.3/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.3/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/zone.js@0.10.2/dist/zone.js"></script>
<script src="https://unpkg.com/reflect-metadata@0.1.3/Reflect.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script src="config.js"></script>
<script>
System.import('app').catch(console.error.bind(console));
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<demo-app>Loading...</demo-app>
</div>
</body>
</html>