Click or drag to resize
RadDesktopAlert Class
This class represents a Desktop Alert component which can be used to display a small window on the screen to notify the user that an event occurred. The location of the window and the way it appears can be customized.
Inheritance Hierarchy
SystemObject
  Telerik.WinControlsDisposableObject
    Telerik.WinControlsRadObject
      Telerik.WinControlsRadComponent
        Telerik.WinControls.UIRadDesktopAlert

Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI (in Telerik.WinControls.UI.dll) Version: 2017.3.1017.40 (2017.3.1017.40)
Syntax
public class RadDesktopAlert : RadComponent

The RadDesktopAlert type exposes the following members.

Constructors
  NameDescription
Public methodRadDesktopAlert
Creates an instance of the RadDesktopAlert class.
Public methodRadDesktopAlert(IContainer)
Creates an instance of the RadDesktopAlert class.
Top
Properties
  NameDescription
Public propertyAutoClose
Gets a sets a boolean value determining whether the alert popup will be automatically closed after a given amount of time.
Public propertyAutoCloseDelay
Gets or sets the amount of time in seconds after which the alert will be automatically closed.
Public propertyAutoSize

Gets or sets a value indicating whether the control is automatically resized by Height to display its entire contents.

Public propertyBindingContext
Gets or sets the BindingContext for the object.
(Inherited from RadObject.)
Protected propertyBitState
Gets the RadBitVector64 structure that holds all the bit states of the object.
(Inherited from DisposableObject.)
Public propertyButtonItems
Gets or sets the items collection containing the button items shown at the bottom part of the desktop alert's popup.
Public propertyCanMove
Gets or sets a boolean value determining whether the popup can be moved by dragging the caption grip.
Protected propertyCanRaiseEvents (Inherited from RadComponent.)
Public propertyCaptionText
Gets or sets the alert's caption text. The caption text is displayed below the moving grip of the alert's popup.
Public propertyContainer (Inherited from RadComponent.)
Public propertyContentImage
Gets or sets the content image of the RadDesktopAlert.
Public propertyContentText
Gets or sets the text displayed in the alert popup. This text can be additinally HTML formatted to achieve better appearance.
Protected propertyDesignMode (Inherited from RadComponent.)
Public propertyDpiScaleElement
This element is used for the sole purpose of storing the current DPI scale.
Protected propertyEvents
Provides a simple list of delegates.
(Inherited from DisposableObject.)
Public propertyFadeAnimationFrames
Gets or sets the count of animation frames for the fade animation.
Public propertyFadeAnimationSpeed
Gets or sets the interval in milliseconds between two animation frames.
Public propertyFadeAnimationType
Gets or sets a value from the FadeAnimationType enumerator that determines the type of fade animation performed when the alert's popup is opened/closed.
Public propertyFixedSize
Gets or sets an instance of the Sizestruct which defines fixed size for the alert's popup. The default value is an empty size. In this case the popup adjusts its size according to its content. Otherwise the value of this property is considered.
Public propertyIsDesignMode (Inherited from RadComponent.)
Public propertyIsDisposed
Determines whether the object is already disposed.
(Inherited from DisposableObject.)
Public propertyIsDisposing
Determines whether the object is in a process of being disposed of.
(Inherited from DisposableObject.)
Public propertyIsPinned
Gets or sets a boolean value determining whether the alert's popup will be pinned on the screen. If pinned, the alert's popup will not be automatically closed upon mouse click outside its bounds or if the AutoClose property is set to true.
Public propertyOpacity
Gets or sets the initial opacity of the alert's popup.
Public propertyOptionItems
Gets the items collection containing the items added to the options drop-down button of the desktop alert's popup.
Public propertyPlaySound
Gets or sets a boolean value determining whether a sound is played when the alert's popup is shown.
Public propertyPopup
Gets an instance of the DesktopAlertPopupclass that represents the popup of the desktop alert.
Public propertyPopupAnimation
Gets or sets a boolean value determining whether the alert's popup will be animated.
Public propertyPopupAnimationDirection
Gets or sets a value determining the direction of the alert's popup animation.
Public propertyPopupAnimationEasing
Gets or sets the type of the drop-down animation easing.
Public propertyPopupAnimationFrames
Gets or sets the count of the alert's drop-down animation frames.
Public propertyPropertyFilter
Gets or sets a Filter instance, used to filter the ICustomPropertyDescriptor.GetProperties collection.
(Inherited from RadObject.)
Public propertyPropertyValues
Gets a collection containing property values.
(Inherited from RadObject.)
Public propertyRadObjectType
Gets the RadObjectType which is associated with this system type.
(Inherited from RadObject.)
Public propertyRightToLeft
Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.
Public propertyScreenPosition
Gets or sets a value of the AlertScreenPosition enum which defines the position of the alert popup on the working area of the active screen.
Public propertyShowCloseButton
Gets or sets a boolean value determining whether the close button is shown.
Public propertyShowOptionsButton
Gets or sets a boolean value determining whether the options button is shown.
Public propertyShowPinButton
Gets or sets a boolean value determining whether the pin button is shown.
Public propertySite (Inherited from RadComponent.)
Public propertySoundToPlay
Gets or sets the sound which is played when the alert's popup is shown and the PlaySound property is set to true.
Public propertyThemeName
Gets or sets the theme name of the component.
(Inherited from RadComponent.)
Top
Methods
  NameDescription
Protected methodAddStylePropertySetting
Registers a style setting for this instance.
(Inherited from RadObject.)
Public methodBindProperty
Binds the specified property to a property of the provided binding source object.
(Inherited from RadObject.)
Protected methodCanRaisePropertyChangeNotifications
Determines whether the object can raise PropertyChanging and PropertyChanged notifications. Current implementation checks whether the object is disposing or is already disposed of.
(Inherited from RadObject.)
Protected methodClearPropertyStore
Removes all references to external property modifiers such as property bindings, style settings and animations.
(Inherited from RadObject.)
Protected methodCoerceValue
Allows inheritors to force a coersion of the current calculated value for the given property.
(Inherited from RadObject.)
Protected methodCreatePopup
Returns an instance of the DesktopAlertPopup class that represents the alert's popup
Public methodDispose
Releases all resources associated with this object.
(Inherited from DisposableObject.)
Protected methodDispose(Boolean)
Performs the actual Dispose logic.
(Inherited from DisposableObject.)
Protected methodDisposeManagedResources (Overrides RadComponentDisposeManagedResources.)
Protected methodDisposeUnmanagedResources
Releases any UNMANAGED resources used by this object. NOTE: If you declare some unmanaged resources in your class, you should override its finalizer and put disposing logic there also.
(Inherited from DisposableObject.)
Protected methodFinalize (Inherited from RadComponent.)
Protected methodGetBitState
Gets the current bit state for the object, defined by the provided key.
(Inherited from DisposableObject.)
Protected methodGetDefaultValue
Allows inheritors to provide custom default value.
(Inherited from RadObject.)
Protected methodGetInheritedValue
Searches up in the chain of InheritanceParents for a value for the specified property.
(Inherited from RadObject.)
Protected methodGetLocationModifiedByUser
Public methodGetOwnedTreeHandler (Overrides RadComponentGetOwnedTreeHandler.)
Protected methodGetPopupSize
Public methodGetPropertyValue
Gets the RadPropertyValue structure that holds information about the specified property's effective value for this instance. May be null if no effective value is recorded.
(Inherited from RadObject.)
Public methodGetRegisteredRadProperty
Gets the registered property with the specified name.
(Inherited from RadObject.)
Protected methodGetService (Inherited from RadComponent.)
Public methodGetValue
Retrieves the current value for the specified property.
(Inherited from RadObject.)
Public methodGetValueSource
Gets the source of the current value for the specified property.
(Inherited from RadObject.)
Public methodHide
Hides the alert popup from the screen.
Protected methodIsPropertyCancelable
Determines whether the specified property may be canceled.
(Inherited from RadObject.)
Protected methodOnBitStateChanged
Notifies the object for a change in its bit state.
(Inherited from DisposableObject.)
Protected methodOnLocationChangeRequested
Protected methodOnNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the standard .NET PropertyChanged event.
(Inherited from RadObject.)
Protected methodOnNotifyPropertyChanged(String) (Overrides RadObjectOnNotifyPropertyChanged(String).)
Protected methodOnPopupClosed
Protected methodOnPopupClosing
Protected methodOnPopupOpened
Protected methodOnPopupOpening
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Inherited from RadObject.)
Protected methodOnPropertyChanging
Raises the RadPropertyChanging event.
(Inherited from RadObject.)
Protected methodPerformDispose
Performs the core resources release logic.
(Inherited from DisposableObject.)
Public methodRemoveStylePropertySetting(IPropertySetting)
Called when element style condition changes. This method is used internally.
(Inherited from RadObject.)
Public methodRemoveStylePropertySetting(RadProperty)
Called when element style condition changes. This method is used internally.
(Inherited from RadObject.)
Public methodResetLocationModifier
Resets the explicit location modifier. In other words, if the user has modified the location of the alert's popup, the DesktopAlertManager will not consider it when rearranging the visible alerts. This method will reset the explicit location modifier and thus the DesktopAlertManager will continue managing the location of the alert according to its location settings.
Public methodResetValue(RadProperty)
Resets the current value of the specified property. This method will remove any effective value modifier (such as style or animation setting) for the specified property.
(Inherited from RadObject.)
Public methodResetValue(RadProperty, ValueResetFlags)
Resets the current value of the specified property using the provided flags.
(Inherited from RadObject.)
Protected methodResetValueCore
Resets the specified property value, using the provided reset flags.
(Inherited from RadObject.)
Public methodResumePropertyNotifications
Resumes property notifications after a previous SuspendPropertyNotifications call.
(Inherited from RadObject.)
Protected methodSetBitState
Applies the specified boolean value to the BitVector of the object.
(Inherited from DisposableObject.)
Public methodSetDefaultValueOverride
Applies the provided value as an override of the Default value provided by the specified property's metadata.
(Inherited from RadObject.)
Public methodSetValue
Applies the provided value as Local for the specified property.
(Inherited from RadObject.)
Public methodSetValueAtDesignTime
Applies the specified value as Local for the desired property and raises the flag IsLocalValueSetAtDesignTime for that property. All design-time direct property modifications (e.g. item.Text = "Item1") should be done through this method for the property to be properly serialized. If a property is modified through a property grid, the custom property descriptor will automatically apply this logic. This method is used internally.
(Inherited from RadObject.)
Protected methodSetValueCore
Performs the core logic of updating property value.
(Inherited from RadObject.)
Public methodShouldSerializeProperty
Determines whether the property defined by the provided property descriptor should be serialized.
(Inherited from RadObject.)
Public methodShow
Displays the alert popup on the screen at the specified location.
Public methodSuspendPropertyNotifications
Allows PropertyChanging and PropertyChanged notifications to be temporary suspended.
(Inherited from RadObject.)
Public methodToString (Inherited from RadComponent.)
Public methodUnbindProperty
Removes the binding for the specified property.
(Inherited from RadObject.)
Public methodUpdateValue
Forces re-evaluation of the current value for the specified property.
(Inherited from RadObject.)
Protected methodUpdateValueCore
Performs the core value update logic.
(Inherited from RadObject.)
Top
Events
  NameDescription
Public eventClosed
Fires when the alert's popup was closed.
Public eventClosing
Fires when the alert's popup is about to be closed. The closing action can be canceled by modifying the arguments of this event..
Public eventDisposed (Inherited from DisposableObject.)
Public eventDisposing (Inherited from DisposableObject.)
Public eventOpened
Fires when the alert's popup was opened.
Public eventOpening
Fires when the alert's popup is about to be opened. The opening action can be canceled by modifying the arguments of this event.
Public eventPropertyChanged
Occurs when a property of an object changes. Note: if a property which is not a RadProperty changes, the developer is responsible for firing this event by using the INotifyPropertyChanged API.
(Inherited from RadObject.)
Public eventRadPropertyChanged
Occurs when a property of a RadObject changes.
(Inherited from RadObject.)
Public eventRadPropertyChanging
Occurs prior to property of a RadObject changes.
(Inherited from RadObject.)
Top
Extension Methods
  NameDescription
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodCheckAccessOverloaded. (Defined by DispatcherExtensions.)
Public Extension MethodClearIfNoBindingAndSet
Clears if set.
(Defined by CommonExtensions.)
Public Extension MethodClearIfSet
Clears the property if a value has been set.
(Defined by CommonExtensions.)
Public Extension MethodIsLocalValueSet
Determines whether the specified dependency property local value is set.
(Defined by CommonExtensions.)
Public Extension MethodSetIfDifferent
Sets the value of the dependencyProperty property if it's hasn't that value currently.
(Defined by CommonExtensions.)
Top
See Also