GetVariantEventArgs Class

Argument class for event raised when variant is requested.

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.PortalEngine.GetVariantEventArgs

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131

Syntax

public class GetVariantEventArgs : CMSEventArgs

The GetVariantEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	GetVariantEventArgs

Properties

	Name	Description
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	DocumentIdIsNull	If set, adds check to SQL query whether the variant document id is or is not null. When null, skips the check.
Public property	OriginalEventArgs	Obsolete. Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	PageTemplateID	Current page template ID
Public property	VariantID	ID of return variant
Public property	VariantName	Name of the variant to find.s
Public property	VariantType	Type of variant event is using.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	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 method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Obsolete. Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)