ToastNotificationsManager Members
The component that displays Windows Modern UI-inspired toast notifications. See Toast Notification Manager.Constructors
| Name | Description |
|---|---|
| ToastNotificationsManager() | Initializes a new instance of the ToastNotificationsManager class with the default settings. |
| ToastNotificationsManager(IContainer) | Initializes a new instance of the ToastNotificationsManager class with the specified settings. |
Properties
| Name | Description |
|---|---|
| ApplicationActivator | Gets or sets the toast Activator - a descendant of the DevExpress.XtraBars.ToastNotifications.ToastNotificationActivator class that allows you to manage end-user interactions with toast elements (buttons, selection menus and input boxes). You should not set this property in code (see the “Remarks” section below for more information). |
| ApplicationIconPath | Gets or sets the path to the application icon, displayed within toast notifications. |
| ApplicationId | Gets or sets the ID of the application that displays toast notifications using this ToastNotificationsManager. |
| ApplicationName | Gets or sets the caption of an application shortcut, pinned to the Windows 8 Start Screen. |
| AreToastNotificationsSupported static | Gets whether or not toast notifications are supported on this machine. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| CreateApplicationShortcut | Gets or sets whether the application should add its shortcut to the Windows 8 Start Screen. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| IsDisposing | Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent. |
| IsInitialized | Indicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent. |
| IsInitializing | Returns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent. |
| IsUpdateLocked | Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent. |
| Notifications | Provides access to a notification collection owned by this ToastNotificationsManager. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| ThrowOnErrors | Gets or sets whether to throw exceptions that caused notification showing to end prematurely. |
Methods
| Name | Description |
|---|---|
| About() static | Invokes the About dialog box. |
| BeginUpdate() | Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent. |
| CancelUpdate() | Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndUpdate() | Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseComponent. |
| 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. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetNotificationByID(Object) | Returns a notification instance with the given ID. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| HideNotification(IToastNotificationProperties) | Hides the specific notification that matches the notificationProperties parameter. |
| HideNotification(Object) | Hides a specific notification. |
| HideNotifications(IToastNotificationProperties) | Hides all notifications with the specific properties set. |
| HideNotifications(Object) | Hides the notification that has the specific ID. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| LayoutChanged() | Updates the element. Inherited from BaseComponent. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RegisterApplicationActivator(Type) | Registers the Application Activator. |
| ShowNotification(IToastNotificationProperties) | Displays a specific notification. |
| ShowNotification(Object) | Displays a notification with the specific ID. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| TryCreateApplicationShortcut() | Tests whether or not a Start Screen application shortcut with the current ToastNotificationsManager.ApplicationIconPath and ToastNotificationsManager.ApplicationName property values can be created. |
| UnregisterApplicationActivator() | Unregisters the Application Activator. |
Events
| Name | Description |
|---|---|
| Activated | Fires when an end-user clicks an active notification. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| Dropped | Occurs when a toast notification drops without being displayed to a user. |
| Failed | Raises when user settings prevent notifications from being delivered. |
| Hidden | Occurs when a notification owned by this ToastNotificationsManager is hidden via corresponding methods in code. |
| TimedOut | Occurs when a notification lifetime expires. |
| UpdateToastContent | Allows you to customize a notification’s content (visuals, actions, audio, etc.) according to the Toast Content Schema. |
| UserCancelled | Fires if an end-user closes a notification owned by this ToastNotificationsManager. |
See Also