Click or drag to resize
SettingsKeyChangedEventArgs Class
Class containing data for event raised when the settings key is successfuly changed.
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class SettingsKeyChangedEventArgs : CMSEventArgs

The SettingsKeyChangedEventArgs type exposes the following members.

Constructors
  NameDescription
Protected methodSettingsKeyChangedEventArgs
Initializes a new instance of the SettingsKeyChangedEventArgs class.
Public methodSettingsKeyChangedEventArgs(String, Object, Int32, String, SettingsKeyActionEnum)
Initializes a new instance of the SettingsKeyChangedEventArgs class.
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.)
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.)
Public methodCancel
Cancels the current handler execution
(Inherited from CMSEventArgs.)
Public methodDetectRecursion
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 methodDispose
Make sure the objects get disposed
(Inherited from CMSEventArgs.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberEmpty
Represents a settings key changed event with no event data.
Protected fieldmCallWhenFinished
List of actions to be called when the event finishes
(Inherited from CMSEventArgs.)
Top
Properties
  NameDescription
Public propertyAction
Gets the action that was performed on the settings key.
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyFullKeyName
Gets the full name of the key with site name prefix.
Public propertyKeyName
Gets the name of the key.
Public propertyKeyValue
Gets the key value.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertySiteID
Gets the site ID.
Public propertySiteName
Gets the name of the site.
Top
See Also