Configuration
| Name | Description |
|---|---|
| activeStateEnabled | |
| alerts | |
| dataSource | |
| disabled |
Specifies whether the UI component responds to user interaction. |
| elementAttr |
Specifies the global attributes to be attached to the UI component's container element. |
| errors | |
| focusStateEnabled | |
| height |
Specifies the UI component's height. |
| hoverStateEnabled | |
| items | |
| message | |
| onDisposing | |
| onInitialized | |
| onMessageEntered | |
| onMessageSend | |
| onOptionChanged | |
| onTypingEnd | |
| onTypingStart | |
| reloadOnChange | |
| rtlEnabled |
Switches the UI component to a right-to-left representation. |
| showAvatar | |
| showDayHeaders | |
| showMessageTimestamp | |
| showUserName | |
| title | |
| typingUsers | |
| user | |
| visible |
Specifies whether the UI component is visible. |
| width |
Specifies the UI component's width. |
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration properties for this component. |
| dispose() |
Disposes of all the resources allocated to the Chat instance. |
| element() |
Gets the root UI component element. |
| endUpdate() |
Refreshes the UI component after a call of the beginUpdate() method. |
| focus() |
Sets focus on the UI component. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a UI component found using its DOM node. |
| instance() |
Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all UI component properties. |
| option(optionName) |
Gets the value of a single property. |
| option(optionName, optionValue) |
Updates the value of a single property. |
| option(options) |
Updates the values of several properties. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| renderMessage(message) | |
| repaint() |
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) |
Resets a property to its default value. |
Events
| Name | Description |
|---|---|
| disposing |
Raised before the UI component is disposed of. |
| initialized |
Raised only once, after the UI component is initialized. |
| messageEntered | |
| messageSend | |
| optionChanged |
Raised after a UI component property is changed. |
| typingEnd | |
| typingStart |
Types
| Name | Description |
|---|---|
| DisposingEvent | |
| InitializedEvent | |
| Message | |
| MessageSendEvent | |
| OptionChangedEvent | |
| User |
If you have technical questions, please create a support ticket in the DevExpress Support Center.