Class TWizardNavigationEventParameter
TWizardNavigationEventParameter class.
TWizardNavigationEventParameter represents the parameter for TWizard's navigation events. The index of the currently active step can be obtained from CurrentStepIndex, while the index of the candidate new step is in NextStepIndex. By modifying NextStepIndex, the new step can be changed to another one. If there is anything wrong with the navigation and it is not wanted, set CancelNavigation to true.
Constructor Summary |
public |
Constructor.
|
Method Summary |
boolean
|
|
integer
|
|
integer
|
|
void
|
|
void
|
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Constructor Details |
__construct
Constructor.
|
Method Details |
getCancelNavigation
public boolean getCancelNavigation |
() |
Output |
boolean
| whether navigation to the next step should be canceled. Default to false. |
Exception |
|
getCurrentStepIndex
public integer getCurrentStepIndex |
() |
Output |
integer
| the zero-based index of the currently active step. |
Exception |
|
getNextStepIndex
public integer getNextStepIndex |
() |
Output |
integer
| the zero-based index of the next step. Default to CurrentStepIndex. |
Exception |
|
setCancelNavigation
public void setCancelNavigation |
(boolean $value ) |
Input |
boolean | $value | whether navigation to the next step should be canceled. |
Output |
Exception |
|
setNextStepIndex
public void setNextStepIndex |
(integer $index ) |
Input |
integer | $index | the zero-based index of the next step. |
Output |
Exception |
|
|