StepEventArgs Class

Wizard step event arguments

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.ExtendedControls.StepEventArgs

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 9.0.0

Syntax

public class StepEventArgs : CMSEventArgs, 
	ISimpleDataContainer

The StepEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	StepEventArgs	Constructor

Properties

	Name	Description
Public property	BackButtonText	Text for the back button (use in the load event)
Public property	CancelEvent	If true, the current operation should be canceled (refers to the validation and finish event)
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	CurrentStep	Current step index indexed from 0
Public property	FinalStepUrl	Gets or sets the URL which is used after final step
Public property	HideBackButton	If true, the back button is hidden (use in the load event)
Public property	HideNextButton	If true, the next button should be hidden in current step, there is no next action (use in the load event)
Public property	IsFirstStep	Gets the value that indicates whether current step is first step
Public property	IsLastStep	Gets the value that indicates whether current step is last step
Public property	Item	Gets or sets the value from/to object collection
Public property	NextButtonText	Text for the next button (use in the load event)
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	Skip	If true, current step is skipped (use in the load event)
Public property	Steps	Total number of steps

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	GetValue	Gets the value from the object collection
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	SetValue	Sets the value to the object collection
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	UseTransaction	Ensures that the event uses transaction (Defined by DataExtensions.)