Infragistics(R) NetAdvantage(R) Windows Forms
Action Property
See Also  Example E-mail your feedback on this topic.
Infragistics.Win.Misc Namespace > NotificationSettings Class : Action Property

Gets/sets the kind of action that is taken to notify the end user when a validation session fails.

Syntax

Visual Basic (Declaration) 
Public Property Action As NotificationAction
C# 
public NotificationAction Action {get; set;}

Example

The following code sample demonstrates how to use the MessageBoxIcon property in conjunction with some of the NotificationSettings properties to customize the way the end user is notified of a failed validation:

Visual BasicCopy Code
Imports Infragistics.Win
Imports Infragistics.Win.Misc
Imports System.Drawing
Imports System.Drawing.Drawing2D

    Private Sub SetMessageBoxProperties(ByVal ultraValidator As UltraValidator)

        '  Set the MessageBoxIcon property to 'Information' so that
        '  failed validations are not quite as alarming as they are
        '  with the 'Error' setting.
        ultraValidator.MessageBoxIcon = MessageBoxIcon.Information

        '  Get a reference to the NotificationSettings instance which determines
        '  how notifications are handled for all controls associated with this
        '  UltraValidator instance.
        Dim notificationSettings As NotificationSettings = ultraValidator.NotificationSettings

        '  Set the Action property to 'MessageBox' so that a MessageBox
        '  is used to notify the end user of failed validations.
        notificationSettings.Action = NotificationAction.MessageBox

        '  Use the product name for the MessagBox's Caption
        notificationSettings.Caption = Application.ProductName

        '  Use the 'Asterisk' system sound for the audio notification
        notificationSettings.Sound = System.Media.SystemSounds.Asterisk
    End Sub
C#Copy Code
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Text;
using System.Windows.Forms;
using Infragistics.Win;
using Infragistics.Win.Misc;
using System.Drawing;
using System.Drawing.Drawing2D;

    private void SetMessageBoxProperties( UltraValidator ultraValidator )
    {
        //  Set the MessageBoxIcon property to 'Information' so that
        //  failed validations are not quite as alarming as they are
        //  with the 'Error' setting.
        ultraValidator.MessageBoxIcon = MessageBoxIcon.Information;

        //  Get a reference to the NotificationSettings instance which determines
        //  how notifications are handled for all controls associated with this
        //  UltraValidator instance.
        NotificationSettings notificationSettings = ultraValidator.NotificationSettings;

        //  Set the Action property to 'MessageBox' so that a MessageBox
        //  is used to notify the end user of failed validations.
        notificationSettings.Action = NotificationAction.MessageBox;

        //  Use the product name for the MessagBox's Caption
        notificationSettings.Caption = Application.ProductName;

        //  Use the 'Asterisk' system sound for the audio notification
        notificationSettings.Sound = System.Media.SystemSounds.Asterisk;
    }

Remarks

Note: When set to 'BalloonTip', the RetainFocusOnError property must be set to true in order for the balloon tip to be shown.

The Action property determines how the end user is notified of a failed validation, i.e., whether an image, balloon tip, MessageBox, or nothing is displayed.

See Also