This documentation is archived and is not being maintained.

SettingChangingEventArgs Class

Provides data for the SettingChanging event.


Namespace:  System.Configuration
Assembly:  System (in System.dll)

public class SettingChangingEventArgs : CancelEventArgs

The SettingChangingEventArgs type exposes the following members.

Public methodSettingChangingEventArgsInitializes an instance of the SettingChangingEventArgs class.

Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyNewValueGets the new value being assigned to the application settings property.
Public propertySettingClassGets the application settings property category.
Public propertySettingKeyGets the application settings key associated with the property.
Public propertySettingNameGets the name of the application setting associated with the application settings property.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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.