Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

Pinned Property (UltraDesktopAlertShowWindowInfo)

Specifies whether the desktop alert window should be "pinned", i.e., not observe the value of the AutoClose property of the associated UltraDesktopAlert component.
Syntax
'Declaration
 
Public Property Pinned As Boolean
public bool Pinned {get; set;}
Remarks

When this property is set to true, the associated desktop alert window does not automatically close, i.e., the value of the AutoClose property becomes inapplicable.

The Pinned property can be used to set the initial value of the UltraDesktopAlertWindowInfo.Pinned property of the UltraDesktopAlertWindowInfo class, the value of which can be changed by the end user by clicking the PinButtonUIElement, which is displayed when the PinButtonVisible property is set to true.

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:

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 );
    }
Requirements

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

See Also