SoundType Property

Gets or sets a value that indicates which system sound is played.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<SRDescriptionAttribute("Indicates which system sound is played when validation fails.")>
<DefaultValueAttribute()>
Public Property SoundType As SystemSoundType

Dim instance As SoundNotify
Dim value As SystemSoundType
 
instance.SoundType = value
 
value = instance.SoundType

[SRDescription("Indicates which system sound is played when validation fails.")]
[DefaultValue()]
public SystemSoundType SoundType {get; set;}

Property Value

A SystemSoundType value. The default is SystemSoundType.Asterisk.

Example

The following code example uses the CompareValueValidator to validate whether the original value is greater than 10. A system sound is played if the validation fails. Type a value, press the Enter key to end the edit, then press the Esc key to trigger CancelRow. This example is part of a larger example available for the CellValidator class.

void setCompareValueValidator_Click(object sender, EventArgs e)
        {
            Template template = Template.CreateGridTemplate(1);

            CompareValueValidator compareValueValidator = new CompareValueValidator();
            //Set the RequiredType first, then set other properties.
            compareValueValidator.RequiredType = typeof(int);
            compareValueValidator.ComparedValue = 10;
            compareValueValidator.DifferenceValue = 0;
            compareValueValidator.ComparedOperator = ValidateComparisonOperator.GreaterThan;
            

            SoundNotify soundNotify = new SoundNotify();
            soundNotify.SoundType = SystemSoundType.Asterisk;
            //When cancelling the entire row's editing, the old value is restored.
            soundNotify.DoActionReason = ValidateReasons.CancelRow;

            compareValueValidator.Actions.Add(soundNotify);

            //When using the SoundNotify action, the value 9 is validated.
            template.Row.Cells[0].Value = 9;
            template.Row.Cells[0].Validators.Add(compareValueValidator);

            this.gcMultiRow1.Template = template;
            label.Text = "The CompareValueValidator.ComparedValue is 10, DifferenceValue is 0, ComparedOperator is GreaterThan, input a value in the Cell, press ENTER to commit the value (not validate), then press ESC to trigger validation (DoActionReason is CancelRow), the old value 9 is restored and validated, validation fails, a sound is played";
        }

VB.NET

Private Sub setCompareValueValidator_Click(ByVal sender As Object, ByVal e As EventArgs) Handles setCompareValueValidator.Click
        Dim template As Template = template.CreateGridTemplate(1)

        Dim compareValueValidator As New CompareValueValidator()
        'Set the RequiredType first, then set other properties.
        compareValueValidator.RequiredType = GetType(Integer)
        compareValueValidator.ComparedValue = 10
        compareValueValidator.DifferenceValue = 0
        compareValueValidator.ComparedOperator = ValidateComparisonOperator.GreaterThan


        Dim soundNotify As New SoundNotify()
        soundNotify.SoundType = SystemSoundType.Asterisk
        'When cancelling the entire row's editing, the old value is restored.
        soundNotify.DoActionReason = ValidateReasons.CancelRow

        compareValueValidator.Actions.Add(soundNotify)

        'When using the SoundNotify action, the value 9 is validated.
        template.Row.Cells(0).Value = 9
        template.Row.Cells(0).Validators.Add(compareValueValidator)

        Me.gcMultiRow1.Template = template
        label.Text = "The CompareValueValidator.ComparedValue is 10, DifferenceValue is 0, ComparedOperator is GreaterThan, input a value in the cell, press ENTER to commit value (not validate), then press ESC to trigger validation (DoActionReason is CancelRow), the old value 9 is restored and validated, validation fails, a sound is played"
    End Sub

Requirements

Target Platforms: 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

Reference

SoundNotify Class
SoundNotify Members