SettingsKeyChangedEventArgs Class

Class containing data for event raised when the settings key is successfuly changed.

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.DataEngine.SettingsKeyChangedEventArgs

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0

Syntax

public class SettingsKeyChangedEventArgs : CMSEventArgs

The SettingsKeyChangedEventArgs type exposes the following members.

Constructors

	Name	Description
Protected method	SettingsKeyChangedEventArgs()	Initializes a new instance of the SettingsKeyChangedEventArgs class.
Public method	SettingsKeyChangedEventArgs(String, Object, Int32, String, SettingsKeyActionEnum)	Initializes a new instance of the SettingsKeyChangedEventArgs class.

Properties

	Name	Description
Public property	Action	Gets the action that was performed on the settings key.
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	FullKeyName	Gets the full name of the key with site name prefix.
Public property	KeyName	Gets the name of the key.
Public property	KeyValue	Gets the key value.
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	SiteID	Gets the site ID.
Public property	SiteName	Gets the name of the site.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false. (Inherited from CMSEventArgs.)
Public method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)

Extension Methods

	Name	Description
Public Extension Method	UseTransaction	Ensures that the event uses transaction (Defined by DataExtensions.)