The StepEventArgs type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
StepEventArgs |
Constructor
|
Methods
Name | Description | |
---|---|---|
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.) | |
CallWhenFinished |
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.) | |
Cancel |
Cancels the current handler execution
(Inherited from CMSEventArgs.) | |
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.) | |
Dispose |
Make sure the objects get disposed
(Inherited from CMSEventArgs.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue |
Gets the value from the object collection
| |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetValue |
Sets the value to the object collection
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
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 | |
---|---|---|
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
CheckRequiredColumns |
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) | |
UseTransaction |
Ensures that the event uses transaction
(Defined by DataExtensions.) |
Fields
Name | Description | |
---|---|---|
mCallWhenFinished |
List of actions to be called when the event finishes
(Inherited from CMSEventArgs.) |
Properties
Name | Description | |
---|---|---|
BackButtonText |
Text for the back button (use in the load event)
| |
CancelEvent |
If true, the current operation should be canceled (refers to the validation and finish event)
| |
CurrentHandler |
Currently executing handler
(Inherited from CMSEventArgs.) | |
CurrentStep |
Current step index indexed from 0
| |
FinalStepUrl |
Gets or sets the URL which is used after final step
| |
HideBackButton |
If true, the back button is hidden (use in the load event)
| |
HideNextButton |
If true, the next button should be hidden in current step, there is no next action (use in the load event)
| |
IsFirstStep |
Gets the value that indicates whether current step is first step
| |
IsLastStep |
Gets the value that indicates whether current step is last step
| |
Item |
Gets or sets the value from/to object collection
| |
NextButtonText |
Text for the next button (use in the load event)
| |
OriginalEventArgs |
Original event arguments for the event
(Inherited from CMSEventArgs.) | |
Skip |
If true, current step is skipped (use in the load event)
| |
Steps |
Total number of steps
|
See Also