Click or drag to resize
HeaderActionControlCreatedEventArgs Class
Event arguments for when a header action control is being constructed
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.Base.Web.UIHeaderActionControlCreatedEventArgs

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class HeaderActionControlCreatedEventArgs : CMSEventArgs

The HeaderActionControlCreatedEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodHeaderActionControlCreatedEventArgs
Top
Properties
  NameDescription
Public propertyAction
Gets or sets the header action object on which the action control is based.
Public propertyActionControl
Gets or sets the header action control. Is null in Before phase. Is provided in the After phase. Can be overwritten and changed in the After phase. Can be provided in the Before phase if event is then canceled.
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyOriginalEventArgs Obsolete.
Original event arguments for the event
(Inherited from CMSEventArgs.)
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 Obsolete.
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
See Also