Click or drag to resize
CMSEventArgs Class
Base class for the CMS event arguments
Inheritance Hierarchy

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 8.2.23
Syntax
C#
public class CMSEventArgs : EventArgs, 
	IDisposable

The CMSEventArgs type exposes the following members.

Constructors
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
Public methodCancel
Cancels the current handler execution
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.
Public methodDispose
Make sure the objects get disposed
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
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
Protected fieldmCallWhenFinished
List of actions to be called when the event finishes
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
Public propertyOriginalEventArgs
Original event arguments for the event
Top
See Also
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.AutomationAutomationEventArgs
      CMS.AutomationAutomationProcessTriggerEventArgs
      CMS.BaseClassEventArgs
      CMS.BaseCMSEventArgsParameterType
      CMS.BaseDebugEventArgs
      CMS.BaseGetVaryByCustomStringEventArgs
      CMS.BaseQueryEventArgs
      CMS.BaseSystemEventArgs
      CMS.BaseThreadEventArgs
      CMS.BaseThreadQueueWorkerEventArgsTItem
      CMS.BaseURLEventArgs
      CMS.BaseWorkerQueueEventArgs
      CMS.CMSImportExportExportBaseEventArgs
      CMS.CMSImportExportExportSelectionArgs
      CMS.CMSImportExportGetObjectTypeFolderArgs
      CMS.CMSImportExportGetObjectWhereConditionArgs
      CMS.CMSImportExportImportExportBaseEventArgsSettingsType
      CMS.CMSImportExportLoadSelectionArgsSettingsType
      CMS.ControlsEditMenuEventArgs
      CMS.CustomTablesCustomTableItemEventArgs
      CMS.DataEngineColumnsTranslationEventArgs
      CMS.DataEngineExecuteQueryEventArgsTResult
      CMS.DataEngineLogObjectChangeEventArgs
      CMS.DataEngineObjectDataEventArgs
      CMS.DataEngineObjectEventArgsTObject
      CMS.DataEngineSettingsKeyChangedEventArgs
      CMS.DocumentEngineDocumentAuthorizationEventArgs
      CMS.DocumentEngineDocumentDataEventArgs
      CMS.DocumentEngineDocumentEventArgs
      CMS.DocumentEngineDocumentMarkEventArgs
      CMS.DocumentEngineDocumentSearchEventArgs
      CMS.DocumentEngineLogDocumentChangeEventArgs
      CMS.DocumentEnginePageInfoEventArgs
      CMS.DocumentEngineWorkflowEventArgs
      CMS.EcommerceNewOrderCreatedEventArgs
      CMS.EcommerceOrderPaidEventArgs
      CMS.ExtendedControlsGetMediaDataEventArgs
      CMS.ExtendedControlsHeaderActionControlCreatedEventArgs
      CMS.ExtendedControlsSimpleManagerEventArgs
      CMS.ExtendedControlsStepEventArgs
      CMS.FormControlsFormEngineUserControlEventArgs
      CMS.LocalizationLocalizationEventArgs
      CMS.MacroEngineMacroEventArgs
      CMS.MacroEngineMacroSecurityEventArgs
      CMS.MembershipAuthenticationEventArgs
      CMS.MembershipAuthorizationEventArgs
      CMS.MembershipSessionEventArgs
      CMS.MembershipSignOutEventArgs
      CMS.NewslettersGeneratePreviewEventArgs
      CMS.NewslettersGenerateQueueItemsEventArgs
      CMS.NewslettersObtainSubscriberAddressesEventArgs
      CMS.NewslettersResolveMacrosEventArgs
      CMS.OnlineFormsBizFormItemEventArgs
      CMS.OnlineMarketingProcessContactActionsBatchEventArgs
      CMS.OnlineMarketingRecalculateAfterContactActionEventArgs
      CMS.OnlineMarketingRecalculateAfterContactActionsBatchEventArgs
      CMS.OnlineMarketingScoreEventArgs
      CMS.OutputFilterOutputCacheEventArgs
      CMS.OutputFilterSubstitutionEventArgs
      CMS.PortalEngineDeleteVariantEventArgs
      CMS.PortalEngineGetVariantEventArgs
      CMS.PortalEngineGetVariantsEventArgs
      CMS.PortalEngineMoveWebPartsArgs
      CMS.PortalEnginePageTemplateCloneEventArgs
      CMS.PortalEnginePortalEngineEventArgs
      CMS.PortalEngineRemoveWebPartsArgs
      CMS.PortalEngineSetVariantEventArgs
      CMS.PortalEngineWebPartLoadVariantsArgs
      CMS.SearchSearchEventArgs
      CMS.SiteProviderSiteDeletionEventArgs
      CMS.SynchronizationIntegrationTaskEventArgs
      CMS.SynchronizationStagingSynchronizationEventArgs
      CMS.SynchronizationStagingTaskEventArgs
      CMS.TranslationServicesCreateSubmissionItemEventArgs
      CMS.TranslationServicesProcessTranslationEventArgs
      CMS.TranslationServicesTranslationCultureMappingEventArgs
      CMS.UIControlsUniTreeImageArgs
      CMS.URLRewritingEngineProcessABTestEventArgs
      CMS.URLRewritingEngineURLRewritingEventArgs
      CMS.WebAnalyticsActivityLoggedEventArgs
      CMS.WebAnalyticsAnalyticsJSEventArgs
      CMS.WebAnalyticsGenerateStatisticsEventArgs
      CMS.WebAnalyticsProcessActivityEventArgs
      CMS.WorkflowEngineWorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType