JVCL Help:TJvWizard.FindNextPage

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Returns the next page in the wizard before or after a specified page.


Pascal

 functionFindNextPage(PageIndex: Integer; constStep: Integer = 1; CheckDisable: Boolean = True): TJvWizardCustomPage;


Parameters

Parameters Description
PageIndex: Integer The index of the page to start with.
const Step: Integer = 1 The number of pages to step over at each iteration. If Step is > 0, the search moves forward, if Step < 0 the search goes backwards. Do not set Step = 0 as this could cause infinite loops.
CheckDisable: Boolean = True Specifies whether disabled pages are checked.


Return Value

The next page or nil if there is no next page.


Description

Call FindNextPage to locate a page in the wizard by its position relative to the page specified by the PageIndex parameter. If Step is > 0, FindNextPage moves forward through the Pages array. If Step < 0, FindNextPage moves backwards. If PageIndex is not a page in the wizard, FindNextPage returns the first page when Step > 0 or the last page when Step < 0.
When CheckDisabled is True, FindNextPage returns the next page with an Enabled property set to True; if CheckDisabled is False, FindNextPage returns the next page, including pages with Enabled set to False.


See Also

TJvWizard.IsFirstPage, TJvWizard.IsLastPage


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page