ChatBuilder Methods
A Chat UI control.| Name | Description |
|---|---|
| AccessKey(JS) |
Specifies the accessKey attribute for the control’s HTML element.
|
| AccessKey(String) |
Specifies the accessKey attribute for the control’s HTML element.
|
| ActiveStateEnabled(JS) | Mirrors the client-side activeStateEnabled option. |
| ActiveStateEnabled(Boolean) | Mirrors the client-side activeStateEnabled option. |
| Alerts(Action<CollectionFactory<AlertBuilder>>) | A list of available alerts. Mirrors the client-side alerts option. |
| DataSource(JS) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSource(String, String[]) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSourceOptions(Action<DataSourceOptionsBuilder>) | Exposes methods that mirror client-side data source options. |
| DayHeaderFormat(Format) | Specifies the day header format. Mirrors the client-side dayHeaderFormat option. |
| DayHeaderFormat(JS) | Specifies the day header format. Mirrors the client-side dayHeaderFormat option. |
| DayHeaderFormat(Action<FormatBuilder>) | Specifies the day header format. Mirrors the client-side dayHeaderFormat option. |
| DayHeaderFormat(String) | Specifies the day header format. Mirrors the client-side dayHeaderFormat option. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Editing(Action<ChatEditingBuilder>) | Configures editing. Mirrors the client-side editing option. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| EmptyViewTemplate(JS) | |
| EmptyViewTemplate(RazorBlock) | |
| EmptyViewTemplate(TemplateName) | |
| EmptyViewTemplate(String) | |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FileUploaderOptions(Action<FileUploaderOptionsBuilder>) | |
| FocusStateEnabled(JS) | Specifies whether the Chat's input element can be focused using keyboard navigation. Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Specifies whether the Chat's input element can be focused using keyboard navigation. Mirrors the client-side focusStateEnabled option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies the hint text for the Chat component. |
| Hint(String) | Specifies the hint text for the Chat component. |
| HoverStateEnabled(JS) | Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element.
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| Items(Action<CollectionFactory<MessageBuilder>>) | Specifies an array of chat messages. Mirrors the client-side items option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MessageTemplate(JS) | Specifies a custom template for a chat message. Mirrors the client-side messageTemplate option. |
| MessageTemplate(RazorBlock) | Specifies a custom template for a chat message. Mirrors the client-side messageTemplate option. |
| MessageTemplate(TemplateName) | Specifies a custom template for a chat message. Mirrors the client-side messageTemplate option. |
| MessageTemplate(String) | Specifies a custom template for a chat message. Mirrors the client-side messageTemplate option. |
| MessageTimestampFormat(Format) | Specifies the message timestamp format. Mirrors the client-side messageTimestampFormat option. |
| MessageTimestampFormat(JS) | Specifies the message timestamp format. Mirrors the client-side messageTimestampFormat option. |
| MessageTimestampFormat(Action<FormatBuilder>) | Specifies the message timestamp format. Mirrors the client-side messageTimestampFormat option. |
| MessageTimestampFormat(String) | Specifies the message timestamp format. Mirrors the client-side messageTimestampFormat option. |
| OnAttachmentDownloadClick(RazorBlock) | |
| OnAttachmentDownloadClick(String) | |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnMessageDeleted(RazorBlock) | A function that is executed after a message was removed from the UI. Mirrors the client-side onMessageDeleted option. |
| OnMessageDeleted(String) | A function that is executed after a message was removed from the UI. Mirrors the client-side onMessageDeleted option. |
| OnMessageDeleting(RazorBlock) | A function that is executed before a message is removed from the UI. Mirrors the client-side onMessageDeleting option. |
| OnMessageDeleting(String) | A function that is executed before a message is removed from the UI. Mirrors the client-side onMessageDeleting option. |
| OnMessageEditCanceled(RazorBlock) | A function that is executed after message changes are discarded. Mirrors the client-side onMessageEditCanceled option. |
| OnMessageEditCanceled(String) | A function that is executed after message changes are discarded. Mirrors the client-side onMessageEditCanceled option. |
| OnMessageEditingStart(RazorBlock) | A function that is executed before a message switches to the editing state. Mirrors the client-side onMessageEditingStart option. |
| OnMessageEditingStart(String) | A function that is executed before a message switches to the editing state. Mirrors the client-side onMessageEditingStart option. |
| OnMessageEntered(RazorBlock) | A function that is executed after a message is entered into the chat. Mirrors the client-side onMessageEntered option. |
| OnMessageEntered(String) | A function that is executed after a message is entered into the chat. Mirrors the client-side onMessageEntered option. |
| OnMessageUpdated(RazorBlock) | A function that is executed after a message was edited in the UI. Mirrors the client-side onMessageUpdated option. |
| OnMessageUpdated(String) | A function that is executed after a message was edited in the UI. Mirrors the client-side onMessageUpdated option. |
| OnMessageUpdating(RazorBlock) | A function that is executed before a message is edited in the UI. Mirrors the client-side onMessageUpdating option. |
| OnMessageUpdating(String) | A function that is executed before a message is edited in the UI. Mirrors the client-side onMessageUpdating option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnTypingEnd(RazorBlock) | A function that is called 2 seconds after a user stops typing or after a message is entered. Mirrors the client-side onTypingEnd option. |
| OnTypingEnd(String) | A function that is called 2 seconds after a user stops typing or after a message is entered. Mirrors the client-side onTypingEnd option. |
| OnTypingStart(RazorBlock) | A function that is called after a user starts typing. Mirrors the client-side onTypingStart option. |
| OnTypingStart(String) | A function that is called after a user starts typing. Mirrors the client-side onTypingStart option. |
| Option(String, Object) | Specifies an option by its name. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ReloadOnChange(JS) | Specifies whether the Chat UI component displays newly entered messages immediately. This property only applies if dataSource is used. Mirrors the client-side reloadOnChange option. |
| ReloadOnChange(Boolean) | Specifies whether the Chat UI component displays newly entered messages immediately. This property only applies if dataSource is used. Mirrors the client-side reloadOnChange option. |
| Render() | Inherited from WidgetBuilder. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| ShowAvatar(JS) | Specifies whether to show avatars. Mirrors the client-side showAvatar option. |
| ShowAvatar(Boolean) | Specifies whether to show avatars. Mirrors the client-side showAvatar option. |
| ShowDayHeaders(JS) | Specifies whether to show day headers. Mirrors the client-side showDayHeaders option. |
| ShowDayHeaders(Boolean) | Specifies whether to show day headers. Mirrors the client-side showDayHeaders option. |
| ShowMessageTimestamp(JS) | Specifies whether to show message time stamps. Mirrors the client-side showMessageTimestamp option. |
| ShowMessageTimestamp(Boolean) | Specifies whether to show message time stamps. Mirrors the client-side showMessageTimestamp option. |
| ShowUserName(JS) | Specifies whether to show user names. Mirrors the client-side showUserName option. |
| ShowUserName(Boolean) | Specifies whether to show user names. Mirrors the client-side showUserName option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| TypingUsers(Action<CollectionFactory<UserBuilder>>) | An array of users who are currently typing. Mirrors the client-side typingUsers option. |
| User(Action<UserBuilder>) | Specifies the current chat user (messages displayed on the right side). Mirrors the client-side user option. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
See Also