This topic has not yet been rated - Rate this topic

SettingChangingEventArgs Class

Provides data for the SettingChanging event.

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.Configuration.SettingChangingEventArgs

Namespace:  System.Configuration
Assembly:  System (in System.dll)
public class SettingChangingEventArgs : CancelEventArgs

The SettingChangingEventArgs type exposes the following members.

  Name Description
Public method SettingChangingEventArgs Initializes an instance of the SettingChangingEventArgs class.
Top
  Name Description
Public property Cancel Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public property NewValue Gets the new value being assigned to the application settings property.
Public property SettingClass Gets the application settings property category.
Public property SettingKey Gets the application settings key associated with the property.
Public property SettingName Gets the name of the application setting associated with the application settings property.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

The SettingChangingEventArgs class provides data for the SettingChanging event, which signals that the value of an application settings property is about to change. The most common source for this event is the get accessor of the Item method in the ApplicationSettingsBase class.

Because SettingChangingEventArgs is derived from CancelEventArgs, the handler has the option of canceling the write operation.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ