Click or drag to resize
FormEngineUserControlEventArgs Class
Class containing event data pertaining to an event raised for a form control.
Inheritance Hierarchy

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 9.0.0
Syntax
C#
public class FormEngineUserControlEventArgs : CMSEventArgs

The FormEngineUserControlEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodFormEngineUserControlEventArgs
Initializes a new instance of the FormEngineUserControlEventArgs class.
Top
Properties
  NameDescription
Public propertyColumnName
Gets the name of the column (field) this form control works with.
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyFormControl
Gets the form control.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyValue
Gets or sets the value of a form control.
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 MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
See Also