ToastBuilder Methods
A Toast control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| Animation(Action<ToastAnimationBuilder>) | Mirrors the client-side animation object. |
| CloseOnClick(JS) | A Boolean value specifying whether or not the toast is closed if a user clicks it. Mirrors the client-side closeOnClick option. |
| CloseOnClick(Boolean) | A Boolean value specifying whether or not the toast is closed if a user clicks it. Mirrors the client-side closeOnClick option. |
| CloseOnOutsideClick(JS) | Obsolete. Mirrors the client-side closeOnOutsideClick option. |
| CloseOnOutsideClick(Boolean) | Obsolete. Mirrors the client-side closeOnOutsideClick option. |
| CloseOnSwipe(JS) | A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. Mirrors the client-side closeOnSwipe option. |
| CloseOnSwipe(Boolean) | A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. Mirrors the client-side closeOnSwipe option. |
| ContentTemplate(JS) | Specifies the client-side contentTemplate. |
| ContentTemplate(RazorBlock) | Specifies the client-side contentTemplate. |
| ContentTemplate(TemplateName) | Specifies the client-side contentTemplate. |
| ContentTemplate(String) | Specifies the client-side contentTemplate. |
| CopyRootClassesToWrapper(JS) | Obsolete. This API is obsolete now. |
| CopyRootClassesToWrapper(Boolean) | Obsolete. This API is obsolete now. |
| DeferRendering(JS) | Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option. |
| DeferRendering(Boolean) | Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option. |
| DisplayTime(JS) | The time span in milliseconds during which the Toast UI component is visible. Mirrors the client-side displayTime option. |
| DisplayTime(Double) | The time span in milliseconds during which the Toast UI component is visible. Mirrors the client-side displayTime option. |
| ElementAttr(JS) | Obsolete. Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Obsolete. Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Obsolete. Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Obsolete. Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| 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. |
| FocusStateEnabled(JS) | Specifies whether the UI component can be focused using keyboard navigation. Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Specifies whether the UI component 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) | Mirrors the client-side height option. |
| Height(Double) | Mirrors the client-side height option. |
| Height(String) | Mirrors the client-side height option. |
| HideOnOutsideClick(JS) | |
| HideOnOutsideClick(Boolean) | |
| HideOnParentScroll(JS) | |
| HideOnParentScroll(Boolean) | |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| HoverStateEnabled(JS) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| MaxHeight(JS) | Mirrors the client-side maxHeight option. |
| MaxHeight(Double) | Mirrors the client-side maxHeight option. |
| MaxHeight(String) | Mirrors the client-side maxHeight option. |
| MaxWidth(JS) | Mirrors the client-side maxWidth option. |
| MaxWidth(Double) | Mirrors the client-side maxWidth option. |
| MaxWidth(String) | Mirrors the client-side maxWidth option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| Message(JS) | The Toast message text. Mirrors the client-side message option. |
| Message(String) | The Toast message text. Mirrors the client-side message option. |
| MinHeight(JS) | Mirrors the client-side minHeight option. |
| MinHeight(Double) | Mirrors the client-side minHeight option. |
| MinHeight(String) | Mirrors the client-side minHeight option. |
| MinWidth(JS) | Mirrors the client-side minWidth option. |
| MinWidth(Double) | Mirrors the client-side minWidth option. |
| MinWidth(String) | Mirrors the client-side minWidth option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| 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. |
| OnHidden(RazorBlock) | A function that is executed after the UI component is hidden. Mirrors the client-side onHidden option. |
| OnHidden(String) | A function that is executed after the UI component is hidden. Mirrors the client-side onHidden option. |
| OnHiding(RazorBlock) | A function that is executed before the UI component is hidden. Mirrors the client-side onHiding option. |
| OnHiding(String) | A function that is executed before the UI component is hidden. Mirrors the client-side onHiding 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. |
| 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. |
| OnShowing(RazorBlock) | A function that is executed before the UI component is displayed. Mirrors the client-side onShowing option. |
| OnShowing(String) | A function that is executed before the UI component is displayed. Mirrors the client-side onShowing option. |
| OnShown(RazorBlock) | A function that is executed after the UI component is displayed. Mirrors the client-side onShown option. |
| OnShown(String) | A function that is executed after the UI component is displayed. Mirrors the client-side onShown option. |
| Option(String, Object) | Specifies an option by its name. |
| Position(JS) | Mirrors the client-side position option. |
| Position(Action<PositionConfigBuilder>) | Mirrors the client-side position object. |
| Position(String) | Mirrors the client-side position option. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| 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. |
| Shading(JS) | Mirrors the client-side shading option. |
| Shading(Boolean) | Mirrors the client-side shading option. |
| ShadingColor(JS) | Specifies the shading color. Applies only if shading is enabled. Mirrors the client-side shadingColor option. |
| ShadingColor(String) | Specifies the shading color. Applies only if shading is enabled. Mirrors the client-side shadingColor option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| Type(ToastType) | Specifies the Toast UI component type. Mirrors the client-side type option. |
| Visible(JS) | A Boolean value specifying whether or not the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | A Boolean value specifying whether or not the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Mirrors the client-side width option. |
| Width(Double) | Mirrors the client-side width option. |
| Width(String) | Mirrors the client-side width option. |
| WrapperAttr(JS) | Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element. |
| WrapperAttr(Dictionary<String, Object>) | Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element. |
| WrapperAttr(Object) | Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element. |
| WrapperAttr(String, Object) | Mirrors the client-side wrapperAttr option, specifies attributes for the control’s root HTML element. |
See Also