Class Toast

Inheritance
System.Object
EJTagHelper
Toast
Inherited Members
Namespace: Syncfusion.EJ2.Notifications
Assembly: Syncfusion.EJ2.dll
Syntax
public class Toast : EJTagHelper

Constructors

Toast()

Declaration
public Toast()

Properties

Animation

Specifies the animation configuration settings for showing and hiding the Toast.

Declaration
public ToastToastAnimationSettings Animation { get; set; }
Property Value
Type Description
ToastToastAnimationSettings

BeforeOpen

Triggers the event before the toast shown.

Declaration
public string BeforeOpen { get; set; }
Property Value
Type Description
System.String

BeforeSanitizeHtml

Event triggers before sanitize the value.

Declaration
public string BeforeSanitizeHtml { get; set; }
Property Value
Type Description
System.String

Buttons

Specifies the collection of Toast action buttons to be rendered with the given Button model properties and its click action handler.

Declaration
public List<ToastButtonModelProp> Buttons { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ToastButtonModelProp>

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Click

The event will be fired while clicking on the Toast.

Declaration
public string Click { get; set; }
Property Value
Type Description
System.String

Close

Trigger the event after the Toast hides.

Declaration
public string Close { get; set; }
Property Value
Type Description
System.String

Content

Specifies the content to be displayed on the Toast. Accepts selectors, string values and HTML elements.

Declaration
public string Content { get; set; }
Property Value
Type Description
System.String

ContentTemplate

To get or set value for ContentTemplate.

Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type Description
MvcTemplate<System.Object>

Created

Triggers the event after the Toast gets created.

Declaration
public string Created { get; set; }
Property Value
Type Description
System.String

CssClass

Defines single/multiple classes (separated by space) to be used for customization of Toast.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

Destroyed

Triggers the event after the Toast gets destroyed.

Declaration
public string Destroyed { get; set; }
Property Value
Type Description
System.String

EnableHtmlSanitizer

Defines whether to allow the cross-scripting site or not.

Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

ExtendedTimeout

Specifies the Toast display time duration after interacting with the Toast.

Declaration
public double ExtendedTimeout { get; set; }
Property Value
Type Description
System.Double

Height

Specifies the height of the Toast in pixels/number/percentage. Number value is considered as pixels.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

Icon

Defines CSS classes to specify an icon for the Toast which is to be displayed at top left corner of the Toast.

Declaration
public string Icon { get; set; }
Property Value
Type Description
System.String

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

NewestOnTop

Specifies the newly created Toast message display order while multiple toast's are added to page one after another. By default, newly added Toast will be added after old Toast's.

Declaration
public bool NewestOnTop { get; set; }
Property Value
Type Description
System.Boolean

Open

Triggers the event after the Toast shown on the target container.

Declaration
public string Open { get; set; }
Property Value
Type Description
System.String

Position

Specifies the position of the Toast message to be displayed within target container. In the case of multiple Toast display, new Toast position will not update on dynamic change of property values until the old Toast messages removed. X values are: Left , Right ,Center Y values are: Top , Bottom

Declaration
public ToastToastPosition Position { get; set; }
Property Value
Type Description
ToastToastPosition

ProgressDirection

Specifies whether to show the progress bar with left to right direction to denote the Toast message display timeout.

Declaration
public ProgressDirectionType ProgressDirection { get; set; }
Property Value
Type Description
ProgressDirectionType

ShowCloseButton

Specifies whether to show the close button in Toast message to close the Toast.

Declaration
public bool ShowCloseButton { get; set; }
Property Value
Type Description
System.Boolean

ShowProgressBar

Specifies whether to show the progress bar to denote the Toast message display timeout.

Declaration
public bool ShowProgressBar { get; set; }
Property Value
Type Description
System.Boolean

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Target

Specifies the target container where the Toast to be displayed. Based on the target, the positions such as Left, Top will be applied to the Toast. The default value is null, which refers the document.body element.

Declaration
public string Target { get; set; }
Property Value
Type Description
System.String

Template

Specifies the HTML element/element ID as a string that can be displayed as a Toast. The given template is taken as preference to render the Toast, even if the built-in properties such as title and content are defined.

Declaration
public string Template { get; set; }
Property Value
Type Description
System.String

TimeOut

Specifies the Toast display time duration on the page in milliseconds.

  • Once the time expires, Toast message will be removed.
  • Setting 0 as a time out value displays the Toast on the page until the user closes it manually.
Declaration
public double TimeOut { get; set; }
Property Value
Type Description
System.Double

Title

Specifies the title to be displayed on the Toast. Works only with string values.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

Width

Specifies the width of the Toast in pixels/numbers/percentage. Number value is considered as pixels. In mobile devices, default width is considered as 100%.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String