'Declaration Public Class UltraDesktopAlertShowWindowInfo
public class UltraDesktopAlertShowWindowInfo
The UltraDesktopAlertShowWindowInfo class exposes properties which represent the attributes of a desktop alert window which are unique to that particular desktop alert. For example, the Image property provides an easy way to specify the image which is displayed for a particular desktop alert window, while not affecting the image that is displayed for any other desktop alert window.
The desktop alert window extends the ability to display hyperlinks which, when clicked by the end user, generate the DesktopAlertLinkClicked event.
The following table cross references the key properties of the UltraDesktopAlertShowWindowInfo class, along with a brief description of the functionality they provide:
| Property | Description | See also |
|---|---|---|
| Caption | Under the 'Office2007' Style, the caption appears as the first line of text in the client area of the desktop alert window, immediately to the right of the main image. It is bolded by default. Under the 'WindowsLiveMessenger' style, the caption appears in the area at the top of the window which appears similar to a Windows titlebar. Note: The value of the Caption property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks |
| Text | Under the 'Office2007' Style, the text appears immediately under the caption. It is non-bolded by default. Under the 'WindowsLiveMessenger' style, the text appears as the first line of text in the client area, immediately to the right of the main image. Note: The value of the Text property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks |
| Image | The image appears in the client area of the desktop alert window, to the left of the Text. The property can be left at its default value (null), in which case the value of the Image property of the Appearance is displayed; when this is also not set, the default image (an exclamation point graphic) is displayed. The size at which the image is displayed is determined by the ImageSize property. | ImageSize |
| Sound | Support exists for playing a sound asynchronously as a desktop alert window is being shown. This relies on the native CLR2.0 support for processing WAV (Waveform Audio Format) data. UltraDesktopAlert can play WAV data via a file path or URL, System.IO.Stream, or System.Media.SystemSound. | UltraDesktopAlertWindowInfo.Sound System.Media.SystemSounds System.Media.SystemSounds |
| ScreenPosition ScreenLocation Screen |
By default, the desktop alert is displayed at the bottom right corner of the primary monitor. The UltraDesktopAlertShowWindowInfo class expose properties to enable the end developer to change this. | UltraDesktopAlertWindowInfo.Bounds AnimationScrollDirectionShow AnimationScrollDirectionAutoClose |
| FooterText | The footer text appears in the bottom right corner of the client area of the desktop alert window; this is the case regardless of the value of the Style property. Note: The value of the FooterText property is realized in the user interface by the WinFormattedLinkLabel, and as such supports hyperlinks and formatted text. Also note, however, that editing of the link or formatted text is not supported. |
Formatted Text and Hyperlinks |
| Data | As a convenience to the end developer, support exists for passing an object to the desktop alert window which can be referenced at any point during the desktop alert's lifetime. This object is not used by the desktop alert window, but is exposed by the UltraDesktopAlertWindowInfo class so that it can be accessed easily from any of the UltraDesktopAlert events. Typical use might be to provide context for an action to be taken in response to (for example) the DesktopAlertLinkClicked event. | DesktopAlertLinkClicked |
| Pinned PinButtonVisible |
A desktop alert can be "pinned", i.e., the auto-close mechanism can be circumvented for a particular desktop alert. A button can also be displayed which enables the end user to pin the desktop alert, so that it does not close unless the end user clicks the close button. When this button is clicked by the end user, the value of the UltraDesktopAlertWindowInfo.Pinned property is inverted. | UltraDesktopAlertWindowInfo.Pinned AutoClose AutoCloseDelay AllowMove |
| VisibleAlertButtons | Unless otherwise specified, all Visible members of the AlertButtons collection are displayed in the desktop alert window. The VisibleAlertButtons collection extends the ability to hide buttons that might not apply for a given desktop alert. | AlertButtons Appearance ButtonImageSize ButtonStyle ButtonAppearance ButtonHotTrackAppearance ButtonPressedAppearance |
While usually not necessary for most applications, the Show(UltraDesktopAlertShowWindowInfo) method returns an instance of the UltraDesktopAlertWindowInfo class, which is for all intents and purposes a snapshot of the associated UltraDesktopAlertShowWindowInfo instance which was used to display the alert. This object provides information about the desktop alert for future reference, and also can be used to programmatically close a desktop alert window, using the Close(UltraDesktopAlertWindowInfo) method.
Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2