aspnetcore-js-devexpress-dot-richedit-9d40420e.md
A ribbon select box item.
export class RibbonSelectBoxItem extends RibbonItemBase
var commandId = "mySelectBox";
var ribbonSelectBox = new DevExpress.RichEdit.RibbonSelectBoxItem(
commandId,
new DevExpress.data.ArrayStore({ data: products, key: "ID" }),
{
beginGroup: true,
width: 150,
displayExpr: "Name",
valueExpr: "ID",
});
var options = DevExpress.RichEdit.createOptions();
options.ribbon.getTab(DevExpress.RichEdit.RibbonTabType.Home).insertItem(ribbonSelectBox, 3);
options.events.customCommandExecuted.addHandler(function(s, e) {
switch (e.commandName) {
case commandId:
console.log(e.parameter);
}
});
var products = [{
"ID": 1,
"Name": "HD Video Player",
}, {
"ID": 2,
"Name": "SuperHD Player",
}, {
"ID": 3,
"Name": "SuperPlasma 50",
}, {
"ID": 4,
"Name": "SuperLED 50",
}, {
"ID": 5,
"Name": "SuperLED 42",
}, {
"ID": 6,
"Name": "SuperLCD 55",
}];
RibbonItemBase RibbonSelectBoxItem
See Also
Initializes a new instance of the RibbonSelectBoxItem class with specified settings.
constructor(
id: RibbonItemId,
dataSource: any[] | any,
options?: RibbonSelectBoxItemOptions
)
| Name | Type | Description |
|---|---|---|
| id | RibbonItemId |
The item identifier.
| | dataSource | any |
The data source.
| | options | RibbonSelectBoxItemOptions |
The item options.
|
Specifies whether the item accepts custom values.
acceptCustomValue?: boolean
| Type | Description |
|---|---|
| boolean |
true to accept custom values; otherwise, false.
|
Set the acceptCustomValue property to true to allow a user to add new values to the select box. Note that in this case, you should implement the onCustomItemCreating handler to create a new data source entry.
var years = [2018, 2019, 2020];
var postfix = ' year';
var createItem = function(year) {
return { text: year.toString() + postfix, value: year};
};
var dataSource = years.map(createItem);
richEdit.updateRibbon(function(ribbon) {
ribbon.getTab(0).insertItem(new DevExpress.RichEdit.RibbonSelectBoxItem(
'CustomDateSelectId', dataSource, {
displayExpr: "text",
valueExpr: "value",
acceptCustomValue: true,
onCustomItemCreating: function (e) {
if (!e.customItem) {
var item = createItem(parseInt(e.text));
e.customItem = item;
dataSource.push(item);
}
}
}));
});
richEdit.events.customCommandExecuted.addHandler(function(s, e) {
console.log(e);
});
Binds the select box to a data source.
dataSource: any[]
| Type | Description |
|---|---|
| any[] |
The data source.
|
Specifies the data field whose values should be displayed.
displayExpr?: string
| Type | Description |
|---|---|
| string |
The name of the data field.
|
Specifies a function that is executed when a user adds a custom item.
onCustomItemCreating?: any
| Type | Description |
|---|---|
| any |
A function that creates a new data source entry.
|
When the acceptCustomValue property is set to true , a user is allowed to add new values to the select box. Write the onCustomItemCreating function code to create a new data source entry.
var years = [2018, 2019, 2020];
var postfix = ' year';
var createItem = function(year) {
return { text: year.toString() + postfix, value: year};
};
var dataSource = years.map(createItem);
richEdit.updateRibbon(function(ribbon) {
ribbon.getTab(0).insertItem(new DevExpress.RichEdit.RibbonSelectBoxItem(
'CustomDateSelectId', dataSource, {
displayExpr: "text",
valueExpr: "value",
acceptCustomValue: true,
onCustomItemCreating: function (e) {
if (!e.customItem) {
var item = createItem(parseInt(e.text));
e.customItem = item;
dataSource.push(item);
}
}
}));
});
richEdit.events.customCommandExecuted.addHandler(function(s, e) {
console.log(e);
});
Specifies the text displayed by the item when its value is empty.
placeholder?: string
| Type | Description |
|---|---|
| string |
The placeholder text.
|
Specifies whether to display the Clear button in the item.
showClearButton: boolean
| Type | Description |
|---|---|
| boolean |
true to display the Clear button; otherwise, false.
|
Specifies options of the text displayed next to the item.
textOptions: RibbonItemTextOptions
| Type | Description |
|---|---|
| RibbonItemTextOptions |
An object that contains text options.
|
Returns the item’s type.
readonly type = RibbonItemType.SelectBox
| Type | Description |
|---|---|
| SelectBox |
Identifies the SelectBox item type.
|
Specifies the currently selected value.
value?: any
| Type | Description |
|---|---|
| any |
The currently selected value.
|
Specifies the data field that provides values for the editor items.
valueExpr?: string
| Type | Description |
|---|---|
| string |
The name of the data field.
|
Specifies the data type of the selected value.
valueType?: string
| Type | Description |
|---|---|
| string |
The selected value type.
|
Specifies the item width.
width?: any
| Type | Description |
|---|---|
| any |
The item width.
|