Show(UltraDesktopAlertShowWindowInfo) Method

Shows the desktop alert window with the specified information.

[Visual Basic]
Overloads Public Function Show( _
   ByVal windowInfo As UltraDesktopAlertShowWindowInfo _
) As UltraDesktopAlertWindowInfo

[C#]
public UltraDesktopAlertWindowInfo Show( 
   UltraDesktopAlertShowWindowInfo windowInfo
);

Parameters

windowInfo: The UltraDesktopAlertShowWindowInfo instance which contains information about the desktop alert window to be displayed.

Return Type

An UltraDesktopAlertWindowInfo instance which contains information about the desktop alert window.

Exceptions

Exception	Description
ArgumentNullException	Thrown when the windowInfo parameter is null.
Exception	Thrown when the UltraDesktopAlertShowWindowInfo.Key property of the specified UltraDesktopAlertShowWindowInfo instance is non-empty, and matches that of an instance that is already open.

Example

The following code sample demonstrates how the properties of the UltraDesktopAlertShowWindowInfo class can be used to customize the visual appearance and content for a particular desktop alert window:

[Visual Basic]

Imports Infragistics.Win

Imports Infragistics.Win.Misc



    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click

        '  If a window with the same key as the one we are about to

        '  show is currently open, return

        If (Me.desktopAlert.IsOpen("myWindow")) Then Return



        '  Create a new instance of the UltraDesktopAlertShowWindowInfo class.

        Dim showInfo As UltraDesktopAlertShowWindowInfo = New UltraDesktopAlertShowWindowInfo()



        '  Set the key to uniquely identify this desktop alert window

        showInfo.Key = "myWindow"



        '  Set the Caption, Text, and FooterText properties using formatting

        '  characters that are recognized by the FormattedTextUIElement.

        showInfo.Caption = "<span style=""font-weight:bold_x003B_"">Caption</span> is bolded<br/>"

        showInfo.Text = "<span style=""text-decoration:underline_x003B_"">Line one of the Text is underlined</span><br/><span style=""font-style:italic_x003B_"">Line two is italicized</span><br/>"

        showInfo.FooterText = "<a href=""www.infragistics.com"">Click to visit the Infragistics website</a>"



        '  Use the ScreenPosition property to make the desktop alert

        '  window appear at the top left corner of the screen

        showInfo.ScreenPosition = ScreenPosition.TopLeft



        '  Use the Screen property to specify which screen the desktop alert

        '  appears in...in the case where the end user has amultiple monitor

        '  setup, this will make the alert appear on the last screen

        showInfo.Screen = Screen.AllScreens(Screen.AllScreens.Length - 1)



        '  Set the image that is displayed in the desktop alert window's

        '  client area, and the sound that is played as the window appears.

        showInfo.Image = New Icon("C:\Icons\DesktopAlert.ico").ToBitmap()

        showInfo.Sound = "C:\windows\media\notify.wav"



        '  The Pinned property can be used to circumvent the auto-close

        '  functionality for a particular desktop alert window. When

        '  Pinned is set to true, a pushpin graphic appears in the close

        '  button area to indicate that the window will stay open.

        showInfo.Pinned = Me.pinWindows



        '  The VisibleAlertButtons collection can be used to hide buttons

        '  for a particular desktop alert window, while not affecting the

        '  contents of the UltraDesktopAlert's AlertButtons collection.

        If (Me.allowAppClose = False) Then



            '  Since the UltraDesktopAlertShowWindowInfo is not yet associated

            '  with an UltraDesktopAlert, we must first populate the VisibleAlertButtons

            '  collection with its buttons

            showInfo.VisibleAlertButtons.InitializeFrom(Me.desktopAlert)



            '  Use the VisibleAlertButtons collection's Remove method to remove

            '  the close button for this particular window.

            showInfo.VisibleAlertButtons.Remove(showInfo.VisibleAlertButtons("close"))

        End If



        '   Show the window

        Me.desktopAlert.Show(showInfo)

    End Sub

[C#]

using Infragistics.Win; 
using Infragistics.Win.Misc; 
using System.Diagnostics; 
 
    private void button1_Click(object sender, EventArgs e) 
    { 
        //  If a window with the same key as the one we are about to 
        //  show is currently open, return; 
        if ( this.desktopAlert.IsOpen("myWindow") ) 
            return; 
 
        //  Create a new instance of the UltraDesktopAlertShowWindowInfo class. 
        UltraDesktopAlertShowWindowInfo showInfo = new UltraDesktopAlertShowWindowInfo(); 
 
        //  Set the key to uniquely identify this desktop alert window 
        showInfo.Key = "myWindow"; 
 
        //  Set the Caption, Text, and FooterText properties using formatting 
        //  characters that are recognized by the FormattedTextUIElement. 
        showInfo.Caption = "<span style=\"font-weight:bold_x003B_\">Caption</span> is bolded<br/>"; 
        showInfo.Text = "<span style=\"text-decoration:underline_x003B_\">Line one of the Text is underlined</span><br/><span style=\"font-style:italic_x003B_\">Line two is italicized</span><br/>"; 
        showInfo.FooterText = "<a href=\"www.infragistics.com\">Click to visit the Infragistics website</a>"; 
 
        //  Use the ScreenPosition property to make the desktop alert 
        //  window appear at the top left corner of the screen 
        showInfo.ScreenPosition = ScreenPosition.TopLeft; 
 
        //  Use the Screen property to specify which screen the desktop alert 
        //  appears in...in the case where the end user has amultiple monitor 
        //  setup, this will make the alert appear on the last screen 
        showInfo.Screen = Screen.AllScreens[Screen.AllScreens.Length - 1]; 
 
        //  Set the image that is displayed in the desktop alert window's 
        //  client area, and the sound that is played as the window appears. 
        showInfo.Image = new Icon( @"C:\Icons\DesktopAlert.ico" ).ToBitmap(); 
        showInfo.Sound = @"C:\windows\media\notify.wav"; 
 
        //  The Pinned property can be used to circumvent the auto-close 
        //  functionality for a particular desktop alert window. When 
        //  Pinned is set to true, a pushpin graphic appears in the close 
        //  button area to indicate that the window will stay open. 
        showInfo.Pinned = this.pinWindows; 
 
        //  The VisibleAlertButtons collection can be used to hide buttons 
        //  for a particular desktop alert window, while not affecting the 
        //  contents of the UltraDesktopAlert's AlertButtons collection. 
        if ( this.allowAppClose == false ) 
        { 
            //  Since the UltraDesktopAlertShowWindowInfo is not yet associated 
            //  with an UltraDesktopAlert, we must first populate the VisibleAlertButtons 
            //  collection with its buttons 
            showInfo.VisibleAlertButtons.InitializeFrom( this.desktopAlert ); 
 
            //  Use the VisibleAlertButtons collection's Remove method to remove 
            //  the close button for this particular window. 
            showInfo.VisibleAlertButtons.Remove( showInfo.VisibleAlertButtons["close"] ); 
        } 
 
        //  Call the Show method to display the desktop alert 
        this.desktopAlert.Show( showInfo ); 
    }

See Also

Language