Click or drag to resize
GetVariantEventArgs Class
Argument class for event raised when variant is requested.
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.PortalEngineGetVariantEventArgs

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

The GetVariantEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodGetVariantEventArgs
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyDocumentIdIsNull
If set, adds check to SQL query whether the variant document id is or is not null. When null, skips the check.
Public propertyOriginalEventArgs Obsolete.
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyPageTemplateID
Current page template ID
Public propertyVariantID
ID of return variant
Public propertyVariantName
Name of the variant to find.s
Public propertyVariantType
Type of variant event is using.
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