UserPreferenceChangingEventArgs Class

Definition

Namespace:

Microsoft.Win32

Assembly:

Microsoft.Win32.SystemEvents.dll

Source:

UserPreferenceChangingEventArgs.cs

Provides data for the UserPreferenceChanging event.

C#

public class UserPreferenceChangingEventArgs : EventArgs

Inheritance

Object

EventArgs

UserPreferenceChangingEventArgs

Examples

The following code example demonstrates how to use the UserPreferenceChangingEventArgs type to monitor the UserPreferenceChanging event. This code example is part of a larger example provided for the SystemEvents class.

C#

using System;
using Microsoft.Win32;

public sealed class App 
{
    static void Main() 
    {         
        // Set the SystemEvents class to receive event notification when a user 
        // preference changes, the palette changes, or when display settings change.
        SystemEvents.UserPreferenceChanging += new 
            UserPreferenceChangingEventHandler(SystemEvents_UserPreferenceChanging);
        SystemEvents.PaletteChanged += new 
            EventHandler(SystemEvents_PaletteChanged);
        SystemEvents.DisplaySettingsChanged += new 
            EventHandler(SystemEvents_DisplaySettingsChanged);        

        // For demonstration purposes, this application sits idle waiting for events.
        Console.WriteLine("This application is waiting for system events.");
        Console.WriteLine("Press <Enter> to terminate this application.");
        Console.ReadLine();
    }

    // This method is called when a user preference changes.
    static void SystemEvents_UserPreferenceChanging(object sender, UserPreferenceChangingEventArgs e) 
    {
        Console.WriteLine("The user preference is changing. Category={0}", e.Category);
    }

    // This method is called when the palette changes.
    static void SystemEvents_PaletteChanged(object sender, EventArgs e)
    {
        Console.WriteLine("The palette changed.");
    }

    // This method is called when the display settings change.
    static void SystemEvents_DisplaySettingsChanged(object sender, EventArgs e)
    {
        Console.WriteLine("The display settings changed.");
    }
}

// This code produces the following output.
// 
//  This app is waiting for system events.
//  Press <Enter> to terminate this application.
//  Display Settings changed.
//  User preference is changing. Category=General

Remarks

A UserPreferenceChanging event occurs when a change to a user preference is about to be applied.

Constructors

UserPreferenceChangingEventArgs(UserPreferenceCategory)

Initializes a new instance of the UserPreferenceChangingEventArgs class using the specified user preference category identifier.

Properties

Category

Gets the category of user preferences that is changing.

Applies to

See also

• UserPreferenceChangingEventHandler
• UserPreferenceCategory
• UserPreferenceChanging
• SystemEvents