Back to Devexpress

AlertControl Members

windowsforms-devexpress-dot-xtrabars-dot-alerter-dot-alertcontrol-dot-underscore-members.md

latest22.1 KB
Original Source

AlertControl Members

The component that supports displaying alert windows.

Constructors

NameDescription
AlertControl()Initializes a new instance of the AlertControl class with the specified settings.
AlertControl(IContainer)Initializes a new instance of the AlertControl class with the specified container.

Properties

NameDescription
AlertFormListStores active classic alert forms (designed without HTML templates). Note that HTML alerts are not Forms, and are stored in the separate HtmlPopupList collection.
AllowHotTrackGets or sets whether text in alert windows is hot-tracked when hovering over it with the mouse.
AllowHtmlTextGets or sets whether HTML tags can be used to format an alert window’s caption and text.
AlwaysShowOnMainDisplayGets or sets whether alerts managed by this AlertControl should always be displayed on the main system display, no matter which display currently shows the application.
AppearanceCaptionProvides appearance settings that are used to paint the captions of alert windows.
AppearanceHotTrackedTextProvides appearance settings that are used to paint the text in alert windows when the text is hovered over.
AppearanceTextProvides appearance settings that are used to paint the text in alert windows when the text is not hovered over.
AutoFormDelayGets or sets an alert window’s delay, in milliseconds.
AutoHeightGets or sets whether the height of alert windows are automatically calculated, according to their content.
ButtonsProvides access to the collection of custom buttons that can be displayed in alert windows.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControlBoxPositionGets or sets the position of an alert window’s control box.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FormDisplaySpeedGets or sets the speed of the appearance of an alert window.
FormLocationGets or sets the screen position where alert windows appear.
FormMaxCountGets or sets the maximum number of simultaneously displayed alert windows.
FormShowingEffectGets or sets an animation effect applied when displaying an alert window.
HideAnimationTypeGets or sets the animation effect played when alerts managed by this Alert Control are dismissed. This property has a higher priority than the AlertControl.FormShowingEffect setting, which specifies the unified animation effect applied when alerts are both shown and hidden.
HtmlImagesGets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag.
HtmlPopupListReturns the list of all currently active alerts with HTML templates. Classic alerts (designed without HTML) are stored in the separate AlertFormList collection.
HtmlTemplateSpecifies the HTML-CSS template used to render alert windows.
HtmlTemplatesGets the collection of HTML-CSS templates.
IgnoreChildrenThis method supports the internal infrastructure and is not intended to be used directly from your code.
ImagesGets or sets the source of images for buttons that can be displayed in alert windows.
LookAndFeelProvides access to settings controlling the look and feel of alert windows.
PopupMenuGets or sets a popup menu associated with alert windows.
PostponedFormListProvides access to alert windows whose display is postponed.
PostponedHtmlPopupListGives access to deferred HTML popup alerts.
ShowAnimationTypeGets or sets the animation effect played when alerts managed by this Alert Control appear on-screen. This property has a higher priority than the FormShowingEffect setting, which specifies the unified animation effect applied when alerts are both shown and hidden.
ShowCloseButtonGets or sets whether the Close button must be displayed in newly created alert windows.
ShowPinButtonGets or sets whether the Pin button must be displayed in newly created alert windows.
ShowToolTipsGets or sets whether tooltips are enabled for custom buttons in alert windows.
SiteGets or sets the ISite of the Component. Inherited from Component.

Methods

NameDescription
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.
Equals(Object, Object) staticDetermines 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.
GetService(Type) protectedReturns 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.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
RaiseAlertClick(AlertInfo, AlertFormCore)Raises the AlertControl.AlertClick event.
RaiseButtonClick(AlertButton, AlertInfo, AlertFormCore)Raises the AlertControl.ButtonClick event.
RaiseButtonDownChanged(AlertButton, AlertInfo, AlertFormCore)Raises the AlertControl.ButtonDownChanged event.
RaiseFormClosing(AlertFormClosingEventArgs)Raises the AlertControl.FormClosing event.
RaiseFormLoad(AlertFormCore)Raises the AlertControl.FormLoad event.
RaiseGetDesiredAlertFormWidth(AlertFormWidthEventArgs)Raises the AlertControl.GetDesiredAlertFormWidth event.
RaiseHtmlElementClick(String, AlertHtmlPopup)Emulates user click on the given HTML element.
RaiseHyperlinkClick(HyperlinkClickEventArgs)Emulates a hyperlink click.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Show(Object, IWin32Window)Displays an alert designed with an HTML template. This method overload specifies the data object from which data-bound HTML elements should retrieve their values.
Show(Form, AlertInfo)Displays an alert window displaying information from the specified AlertInfo structure.
Show(Form, String, String, SvgImage)Displays a classic alert with customized settings.
Show(Form, String, String, Boolean)Displays an alert window with customized content settings.
Show(Form, String, String, Image)Displays an alert window with the specified caption, text and image.
Show(Form, String, String, String, SvgImage, Object, Boolean)Displays a classic alert with customized settings. The displayed alert can close on click.
Show(Form, String, String, String, SvgImage, Object)Displays a classic alert with customized settings.
Show(Form, String, String, String, SvgImage)Displays a classic alert with customized settings.
Show(Form, String, String, String, Image, Object, Boolean)Displays an alert with customized settings and the capability to close on click.
Show(Form, String, String, String, Image, Object)Displays an alert window with the specified settings.
Show(Form, String, String, String, Image)Displays an alert window with the specified text, caption, image and the text displayed when the window’s text region is hot-tracked.
Show(Form, String, String, String)Displays an alert window with the specified text, caption and the text displayed when the window’s text region is hot-tracked.
Show(Form, String, String)Displays an alert window with the specified text and caption.
Show(Form)Displays an empty alert form.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
AlertClickFires when the text of alert windows is clicked.
BeforeFormShowAllows you to customize an alert window’s contents, size, and position before the window is displayed.
ButtonClickFires when a custom button within an alert window has been clicked.
ButtonDownChangedFires when the pressed state of a custom check button within an alert window has been changed.
CustomizeHtmlTemplateAllows you to dynamically customize elements of alert windows rendered from HTML-CSS templates.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
FormClosingFires when an alert window is about to be closed.
FormLoadFires after an alert window has been created, and allows you to customize the window and window’s buttons.
GetDesiredAlertFormWidthAllows you to set an alert window’s width.
HtmlElementMouseClickOccurs when a user clicks an element within an HTML-CSS template.
HyperlinkClick
MouseFormEnterFires when the mouse pointer enters an alert window.
MouseFormLeaveFires when the mouse pointer leaves an alert window.

See Also

AlertControl Class

DevExpress.XtraBars.Alerter Namespace