Click or drag to resize
StepEventArgs Class
Wizard step event arguments
Inheritance Hierarchy

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 9.0.0
public class StepEventArgs : CMSEventArgs, 

The StepEventArgs type exposes the following members.

Public methodStepEventArgs
Public propertyBackButtonText
Text for the back button (use in the load event)
Public propertyCancelEvent
If true, the current operation should be canceled (refers to the validation and finish event)
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyCurrentStep
Current step index indexed from 0
Public propertyFinalStepUrl
Gets or sets the URL which is used after final step
Public propertyHideBackButton
If true, the back button is hidden (use in the load event)
Public propertyHideNextButton
If true, the next button should be hidden in current step, there is no next action (use in the load event)
Public propertyIsFirstStep
Gets the value that indicates whether current step is first step
Public propertyIsLastStep
Gets the value that indicates whether current step is last step
Public propertyItem
Gets or sets the value from/to object collection
Public propertyNextButtonText
Text for the next button (use in the load event)
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertySkip
If true, current step is skipped (use in the load event)
Public propertySteps
Total number of steps
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 methodGetValue
Gets the value from the object collection
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodSetValue
Sets the value to the object collection
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Extension Methods
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
See Also