Back to Devexpress

NotificationService Members

wpf-devexpress-dot-mvvm-dot-ui-dot-notificationservice-dot-underscore-members.md

latest34.0 KB
Original Source

NotificationService Members

Allows you to show Windows 8/10 Style notifications.

Constructors

NameDescription
NotificationService()Initializes a new instance of the NotificationService class.

Fields

NameDescription
ApplicationIdProperty staticIdentifies the NotificationService.ApplicationId dependency property.
CustomNotificationDurationProperty staticIdentifies the NotificationService.CustomNotificationDuration dependency property.
CustomNotificationPositionProperty staticIdentifies the NotificationService.CustomNotificationPosition dependency property.
CustomNotificationScreenProperty staticIdentifies the NotificationService.CustomNotificationScreen dependency property.
CustomNotificationStyleProperty staticIdentifies the NotificationService.CustomNotificationStyle dependency property.
CustomNotificationTemplateProperty staticIdentifies the NotificationService.CustomNotificationTemplate dependency property.
CustomNotificationTemplateSelectorProperty staticIdentifies the NotificationService.CustomNotificationTemplateSelector dependency property.
CustomNotificationVisibleMaxCountProperty staticIdentifies the NotificationService.CustomNotificationVisibleMaxCount dependency property.
PredefinedNotificationDurationProperty staticIdentifies the NotificationService.PredefinedNotificationDuration dependency property.
PredefinedNotificationTemplateProperty staticIdentifies the NotificationService.PredefinedNotificationTemplate dependency property.
SoundProperty staticIdentifies the NotificationService.Sound dependency property.
UnregisterOnUnloadedProperty staticIdentifies the ServiceBase.UnregisterOnUnloaded dependency property. Inherited from ServiceBase.
UseWin8NotificationsIfAvailableProperty staticIdentifies the NotificationService.UseWin8NotificationsIfAvailable dependency property.

Properties

NameDescription
ApplicationActivatorGets or sets the notification Activator - a descendant of the ToastNotificationActivator class that allows you to manage end-user interactions with notification elements (buttons, selection menus and input boxes).
ApplicationIconPathGets or sets the path to the application icon, displayed within Windows 10 Style notifications.
ApplicationIdGets or sets the application id. This is a dependency property.
ApplicationNameGets or sets the caption of an application shortcut, pinned to the Windows 10 Start Screen.
AreWin8NotificationsAvailableGets a value indicating whether native Windows 8/10 notifications are available.
CanFreezeGets a value that indicates whether the object can be made unmodifiable. Inherited from Freezable.
CreateApplicationShortcutGets or sets whether the service should add application shortcut to the Windows 10 Start Screen.
CustomNotificationDurationSpecifies the duration for the display of custom notifications. This is a dependency property.
CustomNotificationPositionGets or sets the position of custom notifications. This is a dependency property.
CustomNotificationScreenGets or sets the monitor where the custom notification is shown. This is a dependency property.
CustomNotificationStyleGets or sets the style of custom notifications. This is a dependency property.
CustomNotificationTemplateGets or sets the template that defines the presentation of custom notifications. This is a dependency property.
CustomNotificationTemplateSelectorGets or sets an object that chooses a custom notification template based on custom logic. This is a dependency property.
CustomNotificationVisibleMaxCountGets or sets maximum number of custom notifications that are shown simultaneously. This is a dependency property.
DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DispatcherGets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
HasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object’s dependency properties. Inherited from Animatable.
IsFrozenGets a value that indicates whether the object is currently modifiable. Inherited from Freezable.
IsSealedGets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
PredefinedNotificationDurationSpecifies the duration for the display of predefined notifications. This is a dependency property.
PredefinedNotificationTemplateGets or sets the template that defines the presentation of predefined notifications. This is a dependency property.
RemoveApplicationShortcutOnUnloadedGets or sets whether the application shortcut should be removed from the Windows 10 Start Screen. This property works only if the application shortcut is created by the service.
SoundGets or sets the sound played when a notification is shown.
UnregisterOnUnloadedGets or sets whether to unregister the service when the associated View is unloaded. This is a dependency property. Inherited from ServiceBase.
UseWin8NotificationsIfAvailableGets or sets a value indicating whether native Windows 8/10 notifications are used. This is a dependency property.

Methods

NameDescription
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
ApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline)Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
CheckAccess()Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
Clone()Creates a modifiable clone of this Animatable, making deep copies of this object’s values. When copying this object’s dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Inherited from Animatable.
CloneCore(Freezable) protectedMakes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
CloneCurrentValue()Creates a modifiable clone (deep copy) of the Freezable using its current values. Inherited from Freezable.
CloneCurrentValueCore(Freezable) protectedMakes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. Inherited from Freezable.
CoerceValue(DependencyProperty)Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateCustomNotification(Object)Creates and returns a custom notification with the specified View Model.
CreateInstance() protectedInitializes a new instance of the Freezable class. Inherited from Freezable.
CreatePredefinedNotification(String, String, String, Object, String)Creates and returns a predefined notification with the specified header and body text and image.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
Freeze()Makes the current object unmodifiable and sets its IsFrozen property to true. Inherited from Freezable.
Freeze(Freezable, Boolean) protected staticIf the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded. Inherited from Freezable.
GetAnimationBaseValue(DependencyProperty)Returns the non-animated value of the specified DependencyProperty. Inherited from Animatable.
GetAsFrozen()Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetAsFrozenCore(Freezable) protectedMakes the instance a frozen clone of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
GetCurrentValueAsFrozen()Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetCurrentValueAsFrozenCore(Freezable) protectedMakes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. Inherited from Freezable.
GetHashCode()Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator()Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType()Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty)Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InvalidateProperty(DependencyProperty)Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
OnChanged() protectedCalled when the current Freezable object is modified. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) protectedThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject) protectedEnsures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. Inherited from Freezable.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protectedOverrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. Inherited from Freezable.
ReadLocalValue(DependencyProperty)Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReadPreamble() protectedEnsures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. Inherited from Freezable.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RegisterApplicationActivator()
SetCurrentValue(DependencyProperty, Object)Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protectedReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ShouldSerializeStoredWeakReference(DependencyObject) staticSpecifies whether a dependency object should be serialized. Inherited from Animatable.
ToString()Returns a string that represents the current object. Inherited from Object.
UnregisterApplicationActivator()
VerifyAccess()Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
WritePostscript() protectedRaises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. Inherited from Freezable.
WritePreamble() protectedVerifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. Inherited from Freezable.

Events

NameDescription
ChangedOccurs when the Freezable or an object it contains is modified. Inherited from Freezable.

See Also

NotificationService Class

DevExpress.Mvvm.UI Namespace