'Declaration Public ReadOnly Property VisibleAlertButtons As DesktopAlertVisibleButtonsCollection
public DesktopAlertVisibleButtonsCollection VisibleAlertButtons {get;}
The VisibleAlertButtons collection makes it possible to control which members of the AlertButtons collection are available for this particular desktop alert. In some situations it may be derirable to hide one or more buttons based on runtime conditions; the VisibleAlertButtons can be used to accomplish this.
Since an UltraDesktopAlertShowWindowInfo instance is not associated with an UltraDesktopAlert until the Show(UltraDesktopAlertShowWindowInfo) method is called, the VisibleAlertButtons collection will contain no members unless it is specifically populated. Since in many situations the end developer will want all desktop alert windows to display the same alert buttons, the VisibleAlertButtons collection only has to be populated in the case where this desktop alert
Note: Since an UltraDesktopAlertShowWindowInfo instance has no association with an UltraDesktopAlert instance until it is passed to the Show(UltraDesktopAlertShowWindowInfo) method, the VisibleAlertButtons collection has no notion of which AlertButtons collection instance it will be associated with, and as such, its Count property will return zero until it is specifically populated. If it is not specifically populated, however, all visible members of the AlertButtons collection (of the UltraDesktopAlert instance on which the Show method was called) will be displayed. This is based on the premise that for most applications, the end developer will want the same alert buttons to be available for all desktop alert windows.
The VisibleAlertButtons property returns an instance of type DesktopAlertVisibleButtonsCollection, which exposes an DesktopAlertVisibleButtonsCollection.InitializeFrom method; this method makes it possible to populate the VisibleAlertButtons collection with all members of the AlertButtons collection of the specified UltraDesktopAlert. The end developer can use this method in conjunction with the DesktopAlertButtonsModifiableCollectionBase.Remove method in cases where only one or two buttons should be removed for this desktop alert window.
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
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 ); }
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